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

EndpointPurposeStageAccess
https://example.contacts.illinois.edu/api/v2/Contacts databaseProdRO
https://example.ticketing.illinois.edu/ticket/rest/api/2/Ticketing systemProdRW
https://example.ticketing-dev.illinois.edu/ticket/rest/api/2/Ticketing systemDevRW
https://example.ticketing-test.illinois.edu/ticket/rest/api/2/Ticketing SystemTestRW
https://example.magnify.illinois.edu/magnify/uiuc-magnifyFinds MAC addresses, IP addresses, and portsProdRO

Example Data Store Documentation

Data StoreData TypeSensitivityNotes
ICSDBMySQL DBInternalRead Only - For finding and comparing local ice cream shops
HeavyRock DBMongoDBInternalRead Only - A list of potential rocks to send through the mail
WatcherDBMySQL DBInternalRead Only - For observing the universe