Example Automation Configuration
Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Pass the automation configuration using curl
with the
--data-binary @<configuration>
option. The exact fields included in
an automation configuration depend on the Cloud Manager project.
This example uses ...
when a field has multiple entries and also in
place of some field values.
1 { 2 "options" : { 3 "downloadBase" : "/var/lib/mongodb-mms-automation", 4 }, 5 "mongoDbVersions" : [ 6 { 7 "name" : "3.2.0", 8 "builds" : [ 9 { 10 "platform" : "windows", 11 "url" : "https ://fastdl.mongodb.org/win32/mongodb-win32-x86_64-2008plus-3.2.0.zip", 12 "gitVersion" : "45d947729a0315accb6d4f15a6b06be6d9c19fe7", 13 "architecture" : "amd64", 14 "bits" : 64, 15 "win2008plus" : true 16 }, 17 ... 18 ], 19 }, 20 ... 21 ], 22 "agentVersion" : { 23 "directoryUrl" : "https://s3.amazonaws.com/mongodb-mms-build-agent/releases/prod/", 24 "name" : "2.6.4.1612-1" 25 }, 26 "monitoringVersions" : [ 27 { 28 "name" : "4.1.0.251-1", 29 "hostname" : "example.net", 30 "baseUrl" : null 31 }, 32 ... 33 ], 34 "backupVersions" : [ 35 { 36 "name" : "4.1.0.347-1", 37 "hostname" : "example.net", 38 "baseUrl" : null 39 }, 40 ... 41 ], 42 "processes" : [ 43 { 44 "name" : "MyCLUSTER_MySHARD_0_0", 45 "processType" : "mongod", 46 "version" : "2.6.7", 47 "hostname" : "testAutoAPI-0.dns.placeholder", 48 "logRotate" : { 49 "sizeThresholdMB" : 1000, 50 "timeThresholdHrs" : 24 51 }, 52 "authSchemaVersion" : 1, 53 "args2_6" : { 54 "net" : { 55 "port" : 27017 56 }, 57 "storage" : { 58 "dbPath" : "/data/MyCLUSTER_MySHARD_0_0" 59 }, 60 "systemLog" : { 61 "path" : "/data/MyCLUSTER_MySHARD_0_0/mongodb.log", 62 "destination" : "file" 63 }, 64 "replication" : { 65 "replSetName" : "MySHARD_0" 66 }, 67 "operationProfiling" : {} 68 } 69 }, 70 ... 71 ], 72 "replicaSets" : [ 73 { 74 "_id" : "MySHARD_0", 75 "members" : [ 76 { 77 "_id" : 0, 78 "host" : "MyCLUSTER_MySHARD_0_0", 79 "priority" : 1, 80 "votes" : 1, 81 "secondaryDelaySecs" : 0, 82 "hidden" : false, 83 "arbiterOnly" : false 84 }, 85 { 86 "_id" : 1, 87 "host" : "MyCLUSTER_MySHARD_0_1", 88 "priority" : 1, 89 "votes" : 1, 90 "secondaryDelaySecs" : 0, 91 "hidden" : false, 92 "arbiterOnly" : false 93 }, 94 { 95 "_id" : 2, 96 "host" : "MyCLUSTER_MySHARD_0_2", 97 "priority" : 1, 98 "votes" : 1, 99 "secondaryDelaySecs" : 0, 100 "hidden" : false, 101 "arbiterOnly" : false 102 } 103 ] 104 }, 105 ... 106 ], 107 "sharding" : [ 108 { 109 "name" : "myShardedCluster", 110 "configServer" : [ 111 "MyCLUSTER_MyCONFIG_SERVER_6", 112 "MyCLUSTER_MyCONFIG_SERVER_7", 113 "MyCLUSTER_MyCONFIG_SERVER_8" 114 ], 115 "shards" : [ 116 { 117 "_id" : "MySHARD_0", 118 "rs" : "MySHARD_0" 119 }, 120 { 121 "_id" : "MySHARD_1", 122 "rs" : "MySHARD_1" 123 } 124 ] 125 } 126 ], 127 "balancer" : { ... }, 128 "auth" : { 129 "authoritativeSet" : false, 130 "disabled" : true 131 "usersDeleted" : [ ], 132 "usersWanted" : [ ] 133 }, 134 "tls" : { ... }, 135 "roles" : [ 136 { 137 "role" : ... , 138 "db" : ... , 139 "privileges" : [ ... ], 140 "roles" : [ ... ] 141 }, 142 ... 143 ], 144 "kerberos" : { 145 "serviceName" : ... 146 }, 147 "indexConfigs" : [ ] 148 }