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

Clarify curl commands for MMS Public API

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Cloud Manager
    • Labels:
      None

      The docs for the MMS Public API include sample curl commands, which is great.

      However, it has two command line options at the end of the line, after the potentially long URL to fetch. One of these options (--digest) is vital, and if not included will cause a "401 Unauthorized" error, even though the API keys and whitelist have been correctly set up.

      When viewing the page on a narrow display, it is extremely easy for the reader to not scroll across, and assume that the unseen rest of the line is merely the URL being demonstrated:

      It's then surprising to discover these arguments at the end of the line:

      Thus, suggest that instead of what the pages have now:

      curl -u "username:apiKey" "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048f0aab01f4/hosts/04cf770dc43c9ff21747ecf71ff9ee78/metrics" --digest -i
      

      they should instead have:

      curl -u "username:apiKey" --digest -i "https://mms.mongodb.com/api/public/v1.0/groups/51b9361d5ae9048f0aab01f4/hosts/04cf770dc43c9ff21747ecf71ff9ee78/metrics"
      

      This applies to all the MMS Public API docs pages that have sample curl commands.

        1. Firefox-20150202-130722.png
          Firefox-20150202-130722.png
          323 kB
        2. Firefox-20150202-130731.png
          Firefox-20150202-130731.png
          230 kB

            Assignee:
            Unassigned Unassigned
            Reporter:
            kevin.pulo@mongodb.com Kevin Pulo
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved:
              9 years, 14 weeks, 4 days ago