Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-11881

Improve Cloud Manager API IP Whitelisting Requirements

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Duplicate
    • Icon: Major - P3 Major - P3
    • None
    • None
    • API, Cloud Manager
    • None

    Description

      ----------------------------

      Original Description

      As is described within the Configure Public API Access section of the documentation:

      Address-based whitelists protect certain API operations. Only client requests that originate from a whitelisted IP address are permitted to perform the operations. If an operation is whitelisted, it is marked as such on its Public API Resources page. To perform whitelisted operations, first create the whitelist of addresses for the operations, as described on this page.

      That said, the manner by which the documentation depicts the IP whitelisting requirements for the relevant endpoints is somewhat inconsistent and usually only depicted on the relevant endpoints' particular documentation page.

      As an example, the Backup Configurations page includes the following sentence within the :

      To update or create a backup configuration, you must issue the request from an IP address on your user account’s whitelist. The backupConfigs resource accepts PATCH requests only from whitelisted IP addresses.

      However, the Snapshots page depicts the IP whitelisting for the relevant endpoint as an admonition:

      IMPORTANT
      To delete a snapshot, you must issue the request from an IP address on your user account’s whitelist.

      It may be helpful to provide a concise list (or table) of all of the endpoints that require IP whitelisting; potentially within either the Public API Resources page or the Configure Public API Access page.
      ----------------------------

      Description

      Scope of changes (files that need work and how much)

      Impact to other docs outside of this product

      MVP (work and date?)

      Resources (e.g. Scope Docs, Invision)

      Attachments

        Activity

          People

            rob.justice@mongodb.com Robert Justice (Inactive)
            luke.phillippi Luke Phillippi
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              5 years, 30 weeks, 1 day ago