Improved Developer Experience with the Atlas Admin API

With MongoDB Atlas, we meet our developers where they are and offer multiple ways to get started and work with Atlas. One of the ways to get started programmatically with Atlas is through the Atlas Administration API. It provides programmatic access to Atlas resources such as clusters, database users, or backups to name a few, enabling developers to perform operational tasks like creating, modifying, and deleting resources. We are excited to announce two key capabilities that will improve the developer experience when working with the Atlas Administration API.

Versioned Atlas Administration API

If you use the Atlas Administration API today, you are working with the unversioned Administration API (/v1). We have heard your feedback on the challenges around the API changes not having a clear policy as well as communication gaps about the new features/ deprecations. To address this, we are excited to now introduce resource-level versioning with our new versioned Atlas Administration API ( /v2). Here is what you can expect:

  1. More predictability and consistency in handling API changes: With this new versioning, any breaking changes that can impact your code will only be introduced in a new resource version. You can rest assured that no breaking changes will affect your production code running the current, stable version. Also, deprecation will occur with the introduction of a new stable API resource version. This will give you at least 1 year to upgrade before the removal of the deprecated resource version. It adds more predictability to what’s coming to the API.

  2. Minimum impact with resource-based versioning: With the resource level versioning, whenever we talk about API versions we’re referring to the actual API resource versions represented by date. So once you migrate from the current unversioned Administration API (/v1) to the new versioned Administration API (/v2), this will point to version 2023-02-01. To make the initial migration process smooth and easy this first resource version applies to all API resources (e.g. /serverless, /backup, /clusters, etc.). However, moving forward, each resource can introduce a new version (e.g. /serverless can move to 2023-06-01, /backup can stay on 2023-02-01) independently from each other at various points in time. The advantage is that if you have not implemented the e.g. /serverless resource and say a new version is introduced, you will not need to take any action. You will only need to take action if and when the resources you are utilizing are deprecated.

  3. More time to plan your migration: Once a particular resource version is deprecated, there will be enough time ( 12 months) before it is removed, so this will give you ample time to plan and transition to the new version.

  4. Improved context and visibility: Our updated documentation has all the details to guide you through the versioning process. Whether it’s a release of a new endpoint, deprecation of an existing resource version, or a non-breaking change to a #stable resource - all of them are now tracked on a dedicated and automatically updated Changelog. Other than that we provide more visibility and context on any API changes through the API specification which presents information for all stable and deprecated resource versions enabling you to access documentation that’s relevant for your particular case.

We have made it very simple for you to get started with the new versioned Administration API (/v2). To start using it you need to migrate from the current Unversioned Administration API (/v1) to the new Versioned Administration API (/v2). This migration can be done smoothly by making two changes in your code:

  1. Update the path of each endpoint from /v1 to /v2.

  2. Add a version header to each endpoint:
    application/vnd.atlas.2023-02-01+json.

The 2023-02-01 version will have a long support timeframe of 2 years from its deprecation, giving you ample time to transition.

Read more about the versioned Admin API. To learn more about the transition process, read our migration guide.

Go SDK for the Atlas Administration API

One of the mechanisms that simplifies interaction with APIs is the availability of SDKs. To make it easy to get started and work with the Versioned Administration API, we are excited to introduce the new Go SDK for the Administration API. If you are a Go developer and have interacted with the Atlas Administration API, you must be familiar with our current Go client. We are now introducing the new Go SDK for the Atlas Admin API. This provides a significantly improved developer experience for Go developers as it supports full endpoint coverage, improves the speed of getting started with the versioned Admin API, provides you a consistent experience when working with the Admin API, and gives you the choice of version for better control of changes and the impact on the scripts. Let’s look at some of the benefits you can expect:

  • Full Atlas Administration API endpoint coverage: The new Go SDK allows you to access all the features and capabilities that the Atlas Administration API offers today with full endpoint coverage. This ensures you can programmatically leverage the full breadth of the developer data platform.

  • Flexibility in choosing the API resource version: When interacting with the new versioned Atlas Administration API through the Go SDK client, you can choose a particular version of the Admin API, giving you control over when you are impacted by breaking changes or always work with the latest version.

  • Ease of use: Your getting started experience for Admin API through the Go SDK client is now much more simplified with fewer lines of code since it includes pre-built functions, structs, and methods that encapsulate the complexity of HTTP requests, authentication, error handling, versioning, and other low-level details.

  • Immediate access to updates: When using the new Go SDK, you can immediately access any newly released Atlas Admin API capabilities. And every time a new version of Atlas is released, the SDK will be quickly updated and continuously maintained, ensuring compatibility with any changes in the API.

Get started today with the GoSDK client. Also, refer to our migration guide to learn more.

← Previous

Unleashing Innovation in the Start-Up Nation: Inside MongoDB Israel

Israel, often referred to as the “start-up nation”, has a thriving tech scene and drive for innovation. In the bustling city of Tel Aviv, our MongoDB office offers a space for employees from across the organization to collaborate, build community, and empower MongoDB customers to unleash the power of software and data. Now with over 50 employees in Tel Aviv, MongoDB Israel is paving the way for data platform transformation in this start-up nation. Read on to learn more about life at MongoDB in Israel. MongoDB has long had a presence in Tel Aviv, but we opened a new office space in December 2022. Located in WeWork Midtown, our Tel Aviv office offers amazing views of the city and coastline, and employees have full access to all of WeWork’s amenities and activities. Not to mention, we offer some great benefits to our employees in Israel, too! 25 days annual leave and 13 Israeli holidays Private medical and life insurance at no cost to employees 90% reimbursement for fertility, surrogacy, and adoption expenses through Carrot, up to a lifetime maximum of 54,500 shekel, plus new parent support through Cleo Twenty weeks of fully paid parental leave (regardless of gender) for employees who have passed their one-year work anniversary Keren Hishtalmut continuing education fund, travel allowance, meal vouchers, and an employee stock purchase program Global company initiatives to support mental well-being, including mental health resources, a free subscription to Headspace, and an employee assistance program What really makes MongoDB unique is its people. According to one team member, “The MongoDB Israel team is truly a standout in the tech industry, characterized by its vibrant energy, diverse talent, and collaborative spirit. We're a collection of individuals from various backgrounds, each contributing unique skills and experiences. This diversity fuels our innovative approach and fosters a dynamic work environment where everyone has an opportunity to grow, learn, and excel.” Hear what some of our employees have to say about working for MongoDB in Israel. Nitzan Aloni, Enterprise Account Executive Israel is a start-up nation; full of unicorns and full of innovation. This is why MongoDB is so perfect for our customers, and we feel it as a sales team. Customers love the technology and are happy to work and engage with us. It has been really wonderful to see the development of MongoDB in Israel, which is now the core developer data platform for many successful companies. Personally, one of my biggest achievements so far has been working with companies within the finance and healthcare industries. These sectors can sometimes be more legacy and less technologically advanced, but my team and I have worked with these customers to increase their confidence and knowledge. Today, almost all the big finance companies in Israel are using Atlas, our cloud managed database service. MongoDB is a major part of their modernization journey at its core. Our team in Israel is full of great minds, a lot of experience and ambition, and amazing energy! If you want to learn and develop yourself, this is the right place for you. Not to mention, the market is full of opportunities for MongoDB. Every company is looking to modernize itself, because today, more than ever, organizations need to be on the cutting edge in order to survive. MongoDB is a driving force for modernization in every sector. We are far from slowing down! Learn more about MongoDB’s opportunity and regional leadership from Vice President Gabriella Cohen. Itay Tevel, Sr. Solutions Architect My journey at MongoDB has been challenging and rewarding. I firmly believe that developers will build the future, and MongoDB empowers them by offering a developer data platform with an optimal user experience that extends far beyond the core database. My role as a Solutions Architect is multi-faceted and keeps me continuously learning while also giving me the opportunity to educate others. One of the most rewarding aspects of my role is the deep, meaningful discussions I have with developers about complex data problems. Even when engaging with teams that have been using MongoDB extensively for many years, we're often able to offer value and insights, thanks to MongoDB Atlas' ability to meet a broad range of customer demands. What sets MongoDB apart is our relentless commitment to the customer's experience. We're not just about developing outstanding technology; we're about ensuring that technology serves our customers in the best way possible. We actively work to remove roadblocks and streamline their journey with us. This customer-centric ethos permeates every level of our organization and informs every decision we make. The MongoDB Israel team is particularly known for its commitment to holistic professional development. Our Solutions Architects don't just focus on the technical aspects of their roles; they also invest considerable time and effort into enhancing their soft skills. This includes honing abilities like negotiation, time management, teamwork, and presentation skills, amongst others. Solutions Architects have the opportunity to evolve into advisory or principal roles, tackling more complex challenges, and expanding their spheres of influence. The interplay between the technical and business aspects of our customer engagements presents a fascinating challenge, one that keeps our Solutions Architects engaged, evolving, and motivated. MongoDB presents an exciting blend of technological innovation, customer engagement, and personal development opportunities. This makes it an ideal place for Solutions Architects looking to make a difference and advance their careers. Daphne Levy, Technical Services Engineer As a Technical Service Engineer (TSE) at MongoDB, every day I have the opportunity to learn and grow in my role. Apart from diving into diverse topics, such as core server performance, queries and indexes, Atlas search, replication, changestreams, and more, I have also had the opportunity to step out of my comfort zone. TSEs at MongoDB have the opportunity to work on challenging, impactful, and complex projects with the help of colleagues. MongoDB supports, respects, and challenges me to exceed my own expectations. Even when I feel uncertain or lacking in knowledge, I always know that someone has my back and people are always available to help me solve a new challenge. That being said, autonomy and ownership are also highly valued. Our managers trust in our abilities. This empowerment enables individuals to be independent in their work and be comfortable taking risks in order to influence the overall success of the team. As a TSE, I feel fulfilled knowing that my contributions play a significant role in the company’s success by helping customers resolve intricate technical issues. The sense of unity and cohesiveness within the team is strong; in Hebrew we call it ‘gibush’ (גיבוש). What I particularly appreciate about the Israeli team is its commitment to diversity and inclusion. We come from various cultures, sometimes different countries, and speak several languages. This diversity of backgrounds leads to a rich array of perspectives and ideas, sparking innovation and creativity. Collaboration among team members is a defining aspect of our work environment. It would be hard to find another tech company that invests so much into its employees. We constantly have the opportunity to develop and participate in training programs, conferences, workshops, and mentorships, along with participating in fun team bonding events that bring us together and help us build a more unified team. Lastly, MongoDB places great importance on maintaining a healthy work-life balance with a supportive environment that prioritizes employee well-being and offers flexibility, which has made it particularly advantageous for me as a working mum. Irina Sidorova, Customer Success Manager Joining MongoDB in Israel was an easy decision for me. I was blown away by how excited and passionate the developer community is about MongoDB. Their energy and genuine love for the technology made me curious and excited to dive deeper into learning more about it. During the interview process, I was impressed by the level of professionalism and humanity displayed by everyone I interacted with. In addition to having great and open conversations with each one of the team members, they provided me with clear expectations and learning materials, which gave me confidence and left me with a feeling that the company sets its people up for success. In my opinion, what really sets MongoDB apart is the culture of constructive feedback. After each interview, I received honest and valuable feedback that helped me to improve for the next round. I believe that this is crucial for personal and professional growth, and it's something that I really appreciate about MongoDB. One of my biggest highlights so far has been leading the Israeli MongoDB Certification Program. The program allowed participants to enrich their knowledge of MongoDB technology with the help of MongoDB University courses and Online Live Webinars with our Israeli-based team of Solution Architects. It was a great reminder of how much developers love the technology and how eager they are to learn more about it. At MongoDB, you'll have the opportunity to work on projects that challenge the technology market and be part of a company that is constantly growing, improving, and evolving. On top of it all, MongoDB is committed to providing employees with the support and resources they need to succeed. The culture is collaborative, supportive, and inclusive, with everyone in the company working together towards a common goal. If you're looking for a dynamic, challenging, and supportive work environment, join us at MongoDB. And in case you’re still debating, the Tel Aviv office is simply stunning – boasting the best view of the city and providing a perfect environment to work in! Join this dynamic team in Tel Aviv - view open roles on our careers site .

June 14, 2023
Next →

MongoDB Database Observability: Integrating with Monitoring Tools

This post is the final in a three-part series on leveraging database observability. Welcome back to our series on Leveraging Database Observability! Our previous post showcased a real-world use case highlighting how MongoDB Atlas’s observability tools effectively tackle database performance challenges. Whether you’re a developer, DBA, or DevOps engineer, our mission is to empower you to harness the full potential of your data through our observability suite . Integrating Atlas metrics with your central enterprise observability tools can simplify your operations. By seamlessly working with popular observability tools, our approach helps teams streamline workflows and enhance visibility across systems. Integrating MongoDB Atlas with third-party monitoring tools MongoDB’s developer data platform combines all essential data services for building modern applications within a unified experience. Our purpose-built observability tools for Atlas environments offer automatic monitoring and optimization, guiding diagnostics tailored specifically for MongoDB. Additionally, we extend Atlas metrics into your existing enterprise observability stack, enabling seamless integration without replacing your current tools. This creates a consolidated, single-pane view that unifies Atlas telemetry with other tech and application metrics, ensuring comprehensive visibility into both database and full-stack performance. This integration empowers you to monitor, receive alerts, and make data-driven decisions within your existing workflows, driving greater efficiency. Below is a quick guide to modifying integration settings through the Atlas UI and the popular integrations we support: Navigate to the Project Integrations page in Atlas. Choose the organization and project you want to configure from the navigation bar. On the Project Integrations page, select the third-party services you’d like to integrate. Configure the chosen services with the required API keys and regions. Critical integrations for your observability platform With Atlas’s Datadog and Prometheus integrations, you can send critical MongoDB metrics to these platforms, empowering detailed, real-time monitoring. Through Datadog , you can track database operation counts, query efficiency, and resource usage, ideal for pinpointing bottlenecks and managing resources. Similarly, Prometheus enables you to monitor essential metrics like query times, connection rates, and memory usage, supporting flexible tracking of database health and performance. Both integrations facilitate proactive detection of issues, alert configuration for resource thresholds, and a cohesive view of Atlas data when visualized in Grafana. Atlas’s integration with PagerDuty streamlines incident management by sending metrics like performance alerts, billing anomalies, and security events directly to PagerDuty. This integration records incidents automatically, notifies teams upon alerts, and supports two-way syncing, ensuring resolved alerts in Atlas are reflected in PagerDuty. It enables efficient incident response and resource allocation to maintain system stability. With Atlas integrations for Microsoft Teams and Slack, you can route key metrics—such as query latency, disk usage, and throughput—to these channels for timely updates. Teams can use these insights for real-time performance monitoring, incident response, and collaboration. Notifications through these platforms ensure your team stays informed on database performance, storage health, and user activity changes as they occur. Use case: Centralized observability with MongoDB Atlas, Datadog, and Slack Let’s walk through a hypothetical scenario for ShopSmart, an e-commerce company that leverages MongoDB Atlas to manage its product catalog and customer data. As traffic surges, the DevOps team faces challenges in monitoring application performance and database health effectively. To tackle these challenges, the team leverages MongoDB Atlas’ integration with Datadog and Slack, creating a powerful observability ecosystem. Integrating MongoDB Atlas with Datadog: The team pushes key MongoDB Atlas metrics into Datadog, such as query performance, connection counts, and Atlas Vector Search metrics. With Datadog, they can visualize these metrics and correlate overall MongoDB performance with their other applications. Out-of-the-box monitors and dedicated dashboards allow the team to track metrics like throughput, average read/write latency, and current connections. This visibility helps pinpoint bottlenecks in real time, ensuring optimal database performance and improving overall application responsiveness. Setting up alerts in Datadog: The team configures alerts for critical metrics like high query latency and increased error rates. When thresholds are breached, Datadog instantly notifies the team. This proactive approach allows the team to address potential performance issues before they impact customers. Integrating Datadog with Slack: To ensure fast communication, alerts are sent directly to the dedicated Slack channel, “ShopSmart-Alerts.” This integration fosters seamless collaboration, enabling the team to discuss and resolve issues in real-time. With these integrations, ShopSmart’s engineering team can monitor performance quickly and address issues efficiently. The unified observability approach enhances operational efficiency, improves the customer experience, and supports ShopSmart’s competitive edge in the e-commerce industry. By leveraging MongoDB Atlas, Datadog, and Slack, the team ensures scalable performance and drives continuous innovation. Conclusion MongoDB Atlas empowers developers and organizations to achieve unparalleled observability and control over their database environments. By seamlessly integrating with central enterprise observability tools, Atlas enhances your ability to monitor performance metrics and ensures you can do so within your existing workflows. This means you can focus on building modern applications confidently, knowing you have the insights and alerts necessary to maintain optimal performance. Embrace the power of MongoDB Atlas and transform your approach to database management—because your applications can thrive when your data is observable. And that wraps up our Leveraging Database Observability series! We hope you learned something new and found value in these discussions. Sign up for MongoDB Atlas , our cloud database service, to see database observability in action. To dive deeper and expand your knowledge, check out this learning byte for more insights on the MongoDB observability suite and how it can enhance your database performance.

November 14, 2024