[DOCS-11881] Improve Cloud Manager API IP Whitelisting Requirements Created: 17/Jul/18  Updated: 17/Jul/18  Resolved: 17/Jul/18

Status: Closed
Project: Documentation
Component/s: API, Cloud Manager
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Luke Phillippi Assignee: Robert Justice (Inactive)
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
Participants:
Days since reply: 5 years, 30 weeks, 1 day ago

 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)



 Comments   
Comment by Ravind Kumar (Inactive) [ 17/Jul/18 ]

Hi luke.phillippi. This work is already being covered in DOCSP-2873. All work done for the Atlas patch will be ported to the CloudManager docs, including cleanups of the referenced sections.

 

Please also note this comment with regards to documenting all whitelist-required endpoints centrally. 

Generated at Thu Feb 08 08:03:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.