{"_id":"@codecapsules/mongodb-atlas-admin-sdk","_rev":"5-2c540d8f90dcd2844d220be5078ebc9a","name":"@codecapsules/mongodb-atlas-admin-sdk","dist-tags":{"latest":"0.0.1-beta.4"},"versions":{"0.0.0-beta.1":{"name":"@codecapsules/mongodb-atlas-admin-sdk","version":"0.0.0-beta.1","keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"author":{"name":"Code Capsules"},"_id":"@codecapsules/mongodb-atlas-admin-sdk@0.0.0-beta.1","maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"homepage":"","dist":{"shasum":"9fde89bdfec5592d9aad7a5884f5e385c0213a48","tarball":"https://registry.npmjs.org/@codecapsules/mongodb-atlas-admin-sdk/-/mongodb-atlas-admin-sdk-0.0.0-beta.1.tgz","fileCount":4946,"integrity":"sha512-f1IgDLCkO/bWajKKBhReRGneeyFY8oQXBwUfdcC9emh9KisMGBaxAzOOwrYYE4sOJJzoXjcAPJQo+2mnrv6tJQ==","signatures":[{"sig":"MEYCIQCzwkxnwNaIP4vYLKGjUdVJL9Q/Sdg4yvrtsl06/fP4HQIhAKa8peM8DPkt6e0kTH8YBVKYZyrLRYQIDKK9Z5B6CeHn","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5417903},"main":"index.js","types":"./index.d.ts","gitHead":"2720dcb3cc73abbf3b49ac57c70151bbe4f5b270","_npmUser":{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},"repository":{"url":"","type":"git"},"_npmVersion":"10.9.2","description":"TypeScript SDK for MongoDB Atlas Administration API","directories":{},"_nodeVersion":"22.13.1","documentation":"","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mongodb-atlas-admin-sdk_0.0.0-beta.1_1773305144199_0.8319530793709953","host":"s3://npm-registry-packages-npm-production"}},"0.0.1-beta.1":{"name":"@codecapsules/mongodb-atlas-admin-sdk","version":"0.0.1-beta.1","keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"author":{"name":"Code Capsules"},"_id":"@codecapsules/mongodb-atlas-admin-sdk@0.0.1-beta.1","maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"homepage":"","dist":{"shasum":"1f7e7813111cf28889bec79bdac36677ea79f83d","tarball":"https://registry.npmjs.org/@codecapsules/mongodb-atlas-admin-sdk/-/mongodb-atlas-admin-sdk-0.0.1-beta.1.tgz","fileCount":4982,"integrity":"sha512-2/ER5Bj2oWb0yNoHr/d08jv+7mHwDxTmRk1d2EJxF71D/UgrOZV417CI+e4jatRnxMeAGo5unX2qyP0xAAixew==","signatures":[{"sig":"MEUCIGtPeCo6nEbouf4RsuDwZyof+w9A9sIMKQw5/wlZE3M4AiEAtKKVXaZpji1tcBQ+9IbfhMdK5vN9jcim12CS3hiZ298=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5416711},"main":"index.js","types":"./index.d.ts","gitHead":"67d3be1397d06f66401a946c19011f91bd434d8b","_npmUser":{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},"repository":{"url":"","type":"git"},"_npmVersion":"10.9.2","description":"TypeScript SDK for MongoDB Atlas Administration API","directories":{},"_nodeVersion":"22.13.1","documentation":"","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mongodb-atlas-admin-sdk_0.0.1-beta.1_1773983635705_0.16259251950108378","host":"s3://npm-registry-packages-npm-production"}},"0.0.1-beta.2":{"name":"@codecapsules/mongodb-atlas-admin-sdk","version":"0.0.1-beta.2","keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"author":{"name":"Code Capsules"},"_id":"@codecapsules/mongodb-atlas-admin-sdk@0.0.1-beta.2","maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"homepage":"","dist":{"shasum":"3aee532c2066188f65b18b5ef36d6e0774447f12","tarball":"https://registry.npmjs.org/@codecapsules/mongodb-atlas-admin-sdk/-/mongodb-atlas-admin-sdk-0.0.1-beta.2.tgz","fileCount":4982,"integrity":"sha512-qT+TfXfdx1IJenQZPGIHoVMd7Umtve/E8/YznsUJnFm5Q2A65rzb2bR1ghlQUizzzg4JnODumXFsNfeKiqEk6g==","signatures":[{"sig":"MEYCIQDnc0CRtul/Wj60w9oHi0Ks2qKNzr/kE2/y3oFIaek/BwIhAPwJE8UJEvKqppn1/SMeqcV2ue1VZmhPQl4XLwaP6l7k","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":5484096},"main":"index.js","types":"./index.d.ts","gitHead":"d6188ce241bdaf353cf5493fbcaaac3fcfad1bc7","_npmUser":{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},"repository":{"url":"","type":"git"},"_npmVersion":"10.9.2","description":"TypeScript SDK for MongoDB Atlas Administration API","directories":{},"_nodeVersion":"22.13.1","documentation":"","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mongodb-atlas-admin-sdk_0.0.1-beta.2_1774607723871_0.6696869183959682","host":"s3://npm-registry-packages-npm-production"}},"0.0.1-beta.3":{"name":"@codecapsules/mongodb-atlas-admin-sdk","version":"0.0.1-beta.3","keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"author":{"name":"Code Capsules"},"_id":"@codecapsules/mongodb-atlas-admin-sdk@0.0.1-beta.3","maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"homepage":"","dist":{"shasum":"8948b7492877e33366e1ada459f6a6e32225eb7b","tarball":"https://registry.npmjs.org/@codecapsules/mongodb-atlas-admin-sdk/-/mongodb-atlas-admin-sdk-0.0.1-beta.3.tgz","fileCount":5190,"integrity":"sha512-pXdHhpA7paNrF4iuLzdyAjlG/rBnLWy1AtEfoKcuhgPgH+rVHB4efqGee+1vzgQq4C/4XkKP0IH6gxCEw846Uw==","signatures":[{"sig":"MEUCIQDqwcDOrGcTkV3mYU0BIPhKLXT8W3k/idr/ZOJ+qwNWGgIgJ0qz72s4HM8sLum+JFvSHXW0poR5UJSHsdjAwMQSGIU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6225310},"main":"index.js","types":"./index.d.ts","gitHead":"ea0c49782d1f5474d4ce8d15730dc67c5544fe64","_npmUser":{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},"repository":{"url":"","type":"git"},"_npmVersion":"10.9.2","description":"TypeScript SDK for MongoDB Atlas Administration API","directories":{},"_nodeVersion":"22.13.1","documentation":"","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/mongodb-atlas-admin-sdk_0.0.1-beta.3_1775644789314_0.09644495085624616","host":"s3://npm-registry-packages-npm-production"}},"0.0.1-beta.4":{"name":"@codecapsules/mongodb-atlas-admin-sdk","version":"0.0.1-beta.4","description":"TypeScript SDK for MongoDB Atlas Administration API","main":"index.js","author":{"name":"Code Capsules"},"keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"repository":{"type":"git","url":""},"homepage":"","documentation":"","_id":"@codecapsules/mongodb-atlas-admin-sdk@0.0.1-beta.4","gitHead":"8ecfa6409560155698250a7b49cfde74fc470cab","types":"./index.d.ts","_nodeVersion":"22.13.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-dmi9pX5UloLtT1WyI89zNu+yTuafGwFp180avBpE3y4GurA47VzOgIFWFgIrySPMYdzREvsOzg6izQKApKllNQ==","shasum":"f56d6cab2ef3b7990a352706c53bd0ed69106e85","tarball":"https://registry.npmjs.org/@codecapsules/mongodb-atlas-admin-sdk/-/mongodb-atlas-admin-sdk-0.0.1-beta.4.tgz","fileCount":5266,"unpackedSize":6194101,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIADbqOuHp8yTJFrn5cM6qp/0ezP5xnGExmcaN5oloi0IAiEAk6/p3v5zDERY4ZQR4Qi1qt2ndH23OspExI0wUMWWT38="}]},"_npmUser":{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},"directories":{},"maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mongodb-atlas-admin-sdk_0.0.1-beta.4_1776413156414_0.16733628299874104"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-12T08:45:44.198Z","modified":"2026-04-17T08:05:56.843Z","0.0.0-beta.1":"2026-03-12T08:45:44.491Z","0.0.1-beta.1":"2026-03-20T05:13:55.929Z","0.0.1-beta.2":"2026-03-27T10:35:24.135Z","0.0.1-beta.3":"2026-04-08T10:39:49.538Z","0.0.1-beta.4":"2026-04-17T08:05:56.614Z"},"author":{"name":"Code Capsules"},"keywords":["mongodb","atlas","api","sdk","typescript","nodejs"],"repository":{"type":"git","url":""},"description":"TypeScript SDK for MongoDB Atlas Administration API","maintainers":[{"name":"mitchellneilson","email":"mitchell@appstrax.tech"},{"name":"vonketelhodtm","email":"miki@codecapsules.io"},{"name":"cameronneilson-appstrax","email":"cameronneilson@appstrax.tech"},{"name":"jacquesdivcc","email":"jacques@codecapsules.io"}],"readme":"# MongoDB Atlas Admin SDK\n\nType-safe TypeScript SDK for the [MongoDB Atlas Administration API v2](https://www.mongodb.com/docs/atlas/api/atlas-admin-api/). Programmatically manage Atlas projects, clusters, organizations, alerts, and more.\n\n> ### Please Note\n>\n> This SDK has been generated using the Atlas Admin OpenAPI spec. It is not officially supported by MongoDB. It is currently developed and maintained by [Code Capsules](https://codecapsules.io).\n\n## Features\n\n- **Fully generated** — Clients generated from the Atlas Admin OpenAPI spec for complete API coverage\n- **Type-safe** — Strongly typed request options and response models with full IntelliSense support\n- **Multiple auth methods** — OAuth2 service account authentication and Digest (API key) authentication\n- **JSDoc on API methods** — Inline documentation for better developer experience\n\n## Installation\n\n```bash\nnpm install @codecapsules/mongodb-atlas-admin-sdk\n```\n\n## Quick Start\n\n### OAuth2 (recommended)\n\nUse [Atlas API keys](https://www.mongodb.com/docs/atlas/api/api-authentication/) with OAuth2 for production applications:\n\n```typescript\nimport { AtlasAdminClient } from \"@codecapsules/mongodb-atlas-admin-sdk\";\n\nconst client = new AtlasAdminClient({\n  auth: {\n    type: \"oauth2\",\n    config: {\n      clientId: process.env.MONGODB_ATLAS_CLIENT_ID!,\n      clientSecret: process.env.MONGODB_ATLAS_CLIENT_SECRET!,\n    },\n  },\n});\n\nconst status = await client.root.getSystemStatus();\nconsole.log(status);\n\nconst projects = await client.projects.listGroups({\n  query: { itemsPerPage: 10, includeCount: true },\n});\nconsole.log(projects.results);\n```\n\n### Digest auth (Atlas API keys)\n\nUse [Atlas API keys](https://www.mongodb.com/docs/atlas/configure-api-access/#create-an-api-key) for simpler setups:\n\n```typescript\nimport { AtlasAdminClient } from \"@codecapsules/mongodb-atlas-admin-sdk\";\n\nconst client = new AtlasAdminClient({\n  auth: {\n    type: \"digest\",\n    config: {\n      publicKey: process.env.MONGODB_ATLAS_PUBLIC_KEY!,\n      privateKey: process.env.MONGODB_ATLAS_PRIVATE_KEY!,\n    },\n  },\n});\n\nconst status = await client.root.getSystemStatus();\nconsole.log(status);\n```\n\n## API Structure\n\nAll API methods use a single `options` object. Path parameters, query parameters, and request bodies are passed via named fields:\n\n```typescript\nconst clusters = await client.clusters.listGroupClusters({\n  groupId: \"64f1f3fd9f0f0f0f0f0f0f0f\",\n  query: { itemsPerPage: 5, includeCount: true },\n});\n```\n\n### Client groups\n\nThe main client exposes API groups aligned with Atlas resource types:\n\n| Group                        | Description                   |\n| ---------------------------- | ----------------------------- |\n| `client.root`                | System status, root endpoints |\n| `client.projects`            | Projects (groups)             |\n| `client.clusters`            | Clusters                      |\n| `client.flexClusters`        | Flex clusters                 |\n| `client.events`              | Atlas events                  |\n| `client.organizations`       | Organizations                 |\n| `client.alertConfigurations` | Alert configurations          |\n| `client.streams`             | Atlas Streams                 |\n\n## Configuration\n\n```typescript\nconst client = new AtlasAdminClient({\n  auth: {\n    type: \"oauth2\",\n    config: {\n      clientId: \"your-client-id\",\n      clientSecret: \"your-client-secret\",\n    },\n  },\n  baseURL: \"https://cloud.mongodb.com/api/atlas/v2\", // default\n  timeout: 30000, // default, in ms\n  defaultHeaders: {\n    \"X-Custom-Header\": \"example\",\n  },\n});\n```\n\n## Error handling\n\nThe SDK throws `AtlasError` for non-2xx responses:\n\n```typescript\nimport { AtlasAdminClient, AtlasError } from \"@codecapsules/mongodb-atlas-admin-sdk\";\n\ntry {\n  await client.projects.getGroup({ groupId: \"invalid\" });\n} catch (error) {\n  if (error instanceof AtlasError) {\n    console.error(error.statusCode, error.endpoint, error.message);\n  }\n}\n```\n\n## Advanced usage\n\nAccess the underlying HTTP client for custom requests:\n\n```typescript\nconst httpClient = client.getHttpClient();\nconst response = await httpClient.get(\"/groups\");\nconsole.log(response.data);\n```\n\n## Requirements\n\n- **Node.js** >= 18.0.0\n\n## Links\n\n- [MongoDB Atlas Documentation](https://www.mongodb.com/docs/atlas/)\n- [Atlas Administration API Reference](https://www.mongodb.com/docs/atlas/api/atlas-admin-api/)\n- [MongoDB Support](https://www.mongodb.com/support)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}