Cybersecurity, Endpoint and Data Stores Documentation Examples
Example Endpoint and Data Store Documentation
About Endpoint and Data Stores Documentation
The purpose of this document is to provide guidance and examples on how to properly document API endpoints and data stores.
Properly documenting endpoints and data stores is expected and helps comply with the IT-08 Development Process Standard IT-08.4.1.
Documented endpoints and data stores should be properly sanitized.
In most cases a table located in your repo's README.md will suffice.
Example Endpoint Documentation
| Endpoint | Purpose | Stage | Access |
|---|---|---|---|
| https://example.contacts.illinois.edu/api/v2/ | Contacts database | Prod | RO |
| https://example.ticketing.illinois.edu/ticket/rest/api/2/ | Ticketing system | Prod | RW |
| https://example.ticketing-dev.illinois.edu/ticket/rest/api/2/ | Ticketing system | Dev | RW |
| https://example.ticketing-test.illinois.edu/ticket/rest/api/2/ | Ticketing System | Test | RW |
| https://example.magnify.illinois.edu/magnify/uiuc-magnify | Finds MAC addresses, IP addresses, and ports | Prod | RO |
Example Data Store Documentation
| Data Store | Data Type | Sensitivity | Notes |
|---|---|---|---|
| ICSDB | MySQL DB | Internal | Read Only - For finding and comparing local ice cream shops |
| HeavyRock DB | MongoDB | Internal | Read Only - A list of potential rocks to send through the mail |
| WatcherDB | MySQL DB | Internal | Read Only - For observing the universe |