Update Cove TODO: Add complete API documentation links
Major discovery - found comprehensive JSON API documentation on N-able site! Added documentation sections: - Core API docs: login, authentication, construct API calls - Key endpoints: enumerate-customers, enumerate-devices, enumerate-device-statistics - Reference docs: API column codes, schema documentation - Architecture and security guides Key findings: - API docs located in "unused" folder but still functional - JSON API structure (likely JSON-RPC or custom format) - Three critical endpoints identified for backup monitoring: 1. enumerate-customers (list all customers) 2. enumerate-devices (list backup devices) 3. enumerate-device-statistics (backup job results - KEY ENDPOINT!) Updated status: - Marked API documentation as found - Changed next action from "find docs" to "read auth docs and test" - Updated Phase 1 to start with reading login/auth documentation Next steps: 1. Read login.htm to understand token authentication 2. Read construct-a-call.htm to understand request format 3. Read enumerate-device-statistics.htm - likely contains backup status data 4. Test in Postman with documented format Documentation base URL: https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/ Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
23e59ab459
commit
32e68d7209
@ -141,15 +141,13 @@ Unified → → Common Processor → JobRun
|
|||||||
|
|
||||||
### Phase 1: API Research & POC
|
### Phase 1: API Research & POC
|
||||||
|
|
||||||
**Step 1: Find API Base URL**
|
**Step 1: Read Authentication Documentation** ✅ DOCUMENTATION FOUND!
|
||||||
- [ ] Check Cove admin portal for API documentation link
|
- [x] API documentation located
|
||||||
- [ ] Common patterns to try:
|
- [ ] **Read:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/login.htm
|
||||||
- `https://api.backup.management/`
|
- [ ] **Read:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/construct-a-call.htm
|
||||||
- `https://api.cove.n-able.com/`
|
- [ ] Document API base URL from docs
|
||||||
- `https://backup.management/api/`
|
- [ ] Document authentication flow (likely JSON-RPC style based on "construct-a-call")
|
||||||
- `https://cloudbackup.management/api/`
|
- [ ] Note any required request format (headers, body structure)
|
||||||
- [ ] Check API user creation page for hints/links
|
|
||||||
- [ ] Look for "API Documentation" or "Developer" menu in portal
|
|
||||||
|
|
||||||
**Step 2: Test Authentication**
|
**Step 2: Test Authentication**
|
||||||
- [ ] Determine token format (Bearer token? API key header? Query param?)
|
- [ ] Determine token format (Bearer token? API key header? Query param?)
|
||||||
@ -221,8 +219,30 @@ Unified → → Common Processor → JobRun
|
|||||||
### Cove Data Protection
|
### Cove Data Protection
|
||||||
- **Product name:** Cove Data Protection (formerly N-able Backup, SolarWinds Backup)
|
- **Product name:** Cove Data Protection (formerly N-able Backup, SolarWinds Backup)
|
||||||
- **Website:** https://www.n-able.com/products/cove-data-protection
|
- **Website:** https://www.n-able.com/products/cove-data-protection
|
||||||
- **API Docs:** [TODO: add link after research]
|
- **API Documentation Base:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/
|
||||||
- **Support:** [TODO: contact info]
|
|
||||||
|
### JSON API Documentation (Found!)
|
||||||
|
|
||||||
|
**Core Documentation:**
|
||||||
|
- 📘 **API Home:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/home.htm
|
||||||
|
- 🔑 **Login/Authentication:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/login.htm
|
||||||
|
- 🔧 **Construct API Calls:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/construct-a-call.htm
|
||||||
|
|
||||||
|
**Key Endpoints for Backupchecks:**
|
||||||
|
- 👥 **Enumerate Customers:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/enumerate-customers.htm
|
||||||
|
- 💻 **Enumerate Devices:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/enumerate-devices.htm
|
||||||
|
- 📊 **Enumerate Device Statistics:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/enumerate-device-statistics.htm
|
||||||
|
|
||||||
|
**Reference:**
|
||||||
|
- 📋 **API Column Codes:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/API-column-codes.htm
|
||||||
|
- 📋 **Legacy Column Codes:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/API-column-codes-legacy.htm
|
||||||
|
- 📐 **Schema Documentation:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/how-to-schema.htm
|
||||||
|
|
||||||
|
**Other Resources:**
|
||||||
|
- 🏗️ **Architecture Guide:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/Architecture-and-Security/Cove-Architecture-Guide.htm
|
||||||
|
- 🔒 **Security Guide:** https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/Architecture-and-Security/Cove-Security-Guide.htm
|
||||||
|
|
||||||
|
**Note:** API docs are in "unused" folder - likely legacy but still functional!
|
||||||
|
|
||||||
### Similar Integrations
|
### Similar Integrations
|
||||||
Other backup systems that use APIs:
|
Other backup systems that use APIs:
|
||||||
@ -270,11 +290,18 @@ Other backup systems that use APIs:
|
|||||||
|
|
||||||
### Immediate Actions (Ready to Start!)
|
### Immediate Actions (Ready to Start!)
|
||||||
|
|
||||||
**1. Find API Documentation**
|
**1. Read API Documentation** ✅ FOUND!
|
||||||
- Check Cove admin portal for "API" or "Developer" section
|
Priority reading order:
|
||||||
- Look for documentation links on the API user creation page
|
1. **Start here:** [Login/Auth](https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/login.htm) - How to authenticate with your token
|
||||||
- Search Cove knowledge base for "API documentation"
|
2. **Then read:** [Construct a Call](https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/construct-a-call.htm) - Request format
|
||||||
- Try common API base URLs with `/docs` or `/swagger` endpoints
|
3. **Key endpoint:** [Enumerate Device Statistics](https://documentation.n-able.com/covedataprotection/USERGUIDE/documentation/Content/unused/service-management/json-api/enumerate-device-statistics.htm) - This likely has backup job data!
|
||||||
|
|
||||||
|
**What to extract from docs:**
|
||||||
|
- API base URL/endpoint
|
||||||
|
- Request format (JSON-RPC? REST? POST body structure?)
|
||||||
|
- How to use the token in requests
|
||||||
|
- Response format examples
|
||||||
|
- Which fields contain backup status/results
|
||||||
|
|
||||||
**2. Quick API Test with Postman** (can be done now with token!)
|
**2. Quick API Test with Postman** (can be done now with token!)
|
||||||
|
|
||||||
@ -469,9 +496,9 @@ Based on POC results, decide architecture approach and start implementation
|
|||||||
- ✅ **Confirmed:** Cove Data Protection HAS API access (mentioned in documentation)
|
- ✅ **Confirmed:** Cove Data Protection HAS API access (mentioned in documentation)
|
||||||
- ✅ **Found:** API user creation location in Cove portal
|
- ✅ **Found:** API user creation location in Cove portal
|
||||||
- ✅ **Created:** API user with SuperUser role and token
|
- ✅ **Created:** API user with SuperUser role and token
|
||||||
- ❓ **Testing needed:** API base URL and authentication method
|
- ✅ **Found:** Complete JSON API documentation (N-able docs site)
|
||||||
- ❓ **Unknown:** Available endpoints and documentation
|
- ✅ **Identified:** Key endpoints (enumerate-customers, enumerate-devices, enumerate-device-statistics)
|
||||||
- 🎯 **Next action:** Test API access with token and find documentation
|
- 🎯 **Next action:** Read authentication docs and test API calls in Postman
|
||||||
|
|
||||||
### API Credentials (Created)
|
### API Credentials (Created)
|
||||||
- **Authentication:** Token-based
|
- **Authentication:** Token-based
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user