API Reference
Complete list of all public API endpoints. Click any endpoint to view detailed documentation with request/response examples.
Base URL:
https://zopnight.com/api| Method | Endpoint | Description |
|---|---|---|
| Authentication | ||
| POST | /auth/login | Authenticate and receive tokens |
| POST | /auth/signup | Create a new user account |
| POST | /auth/refresh | Refresh access token |
| POST | /auth/logout | Invalidate session |
| POST | /auth/email/verify | Request email verification OTP |
| PATCH | /auth/email/otp/validate | Validate OTP code |
| POST | /auth/password/forget | Initiate password reset |
| POST | /auth/password/reset | Complete password reset |
| POST | /auth/saml/initiate | Begin SAML SSO flow |
| POST | /auth/v2/organisation | Create organization |
| Cloud Accounts | ||
| GET | /cloud-accounts | List cloud accounts |
| POST | /cloud-accounts | Connect cloud account |
| GET | /cloud-accounts/{accountID} | Get cloud account |
| PUT | /cloud-accounts/{accountID} | Update cloud account |
| DELETE | /cloud-accounts/{accountID} | Delete cloud account |
| GET | /connect/gcp/oauth-url | Get GCP OAuth URL |
| POST | /connect/gcp/oauth-exchange | Exchange GCP OAuth code |
| POST | /connect/gcp/oauth-finalize | Finalize GCP OAuth |
| Resources | ||
| GET | /resources | List resources with filtering |
| GET | /resources/{resourceID} | Get resource detail |
| GET | /resources/by-ids | Get resources by IDs |
| GET | /resources/filter-fields | Get available filter options |
| POST | /resources/refresh | Trigger discovery refresh |
| GET | /resources/refresh/status | Check refresh status |
| Schedules | ||
| GET | /schedules | List schedules |
| POST | /schedules | Create schedule |
| GET | /schedules/{scheduleID} | Get schedule |
| PUT | /schedules/{scheduleID} | Update schedule |
| DELETE | /schedules/{scheduleID} | Delete schedule |
| POST | /schedules/{scheduleID}/resources/{resourceID} | Attach resource |
| DELETE | /schedules/{scheduleID}/resources/{resourceID} | Detach resource |
| POST | /schedules/{scheduleID}/groups/{groupID} | Attach group |
| DELETE | /schedules/{scheduleID}/groups/{groupID} | Detach group |
| Resource Groups | ||
| GET | /resource-groups | List resource groups |
| POST | /resource-groups | Create resource group |
| GET | /resource-groups/{groupID} | Get resource group |
| PUT | /resource-groups/{groupID} | Update resource group |
| DELETE | /resource-groups/{groupID} | Delete resource group |
| GET | /resource-groups/{groupID}/schedules | Get group schedules |
| POST | /resource-groups/{groupID}/resources/{resourceID} | Add member |
| PATCH | /resource-groups/{groupID}/resources/{resourceID}/sequence | Update execution order |
| DELETE | /resource-groups/{groupID}/resources/{resourceID} | Remove member |
| Overrides | ||
| GET | /overrides | List overrides |
| POST | /overrides | Create override |
| GET | /overrides/{overrideID} | Get override |
| DELETE | /overrides/{overrideID} | Delete override |
| GET | /resource-groups/{groupID}/overrides | List group overrides |
| POST | /resource-groups/{groupID}/overrides | Create group override |
| Actions & Execution | ||
| POST | /actions | Submit manual action |
| POST | /actions/bulk | Submit bulk action |
| GET | /actions/{actionID} | Get action status |
| GET | /actions/bulk/{bulkActionID} | Get bulk action status |
| GET | /state-history | Get state history |
| Reports & Analytics | ||
| GET | /reports/summary | Dashboard summary |
| GET | /reports/trends | Cost trends |
| GET | /reports/costs/resources | Resource costs |
| GET | /reports/providers/summary | Provider summary |
| GET | /reports/resources/summary | Resource summary |
| GET | /reports/snapshots | Monthly snapshots |
| GET | /budgets/summary | Budget summary |
| GET | /budgets | List budgets |
| POST | /budgets | Create budget |
| PUT | /budgets/{budgetID} | Update budget |
| DELETE | /budgets/{budgetID} | Delete budget |
| GET | /events | List scheduler events |
| POST | /events | Record scheduler event |
| Recommendations | ||
| GET | /recommendations/resources | List resources with recommendation summaries |
| GET | /recommendations/rules | List rules with recommendation summaries |
| GET | /recommendations | List individual recommendations |
| GET | /recommendations/summary | Recommendation summary |
| GET | /recommendations/summary/providers | Provider breakdown |
| GET | /recommendations/filter-fields | Get available filter fields |
| GET | /recommendations/resources/{resourceUID} | Resource recommendations (deprecated) |
| GET | /recommendations/{recID}/detail | Recommendation detail |
| PATCH | /recommendations/{recommendationID} | Update recommendation |
| POST | /recommendations/refresh | Refresh recommendations |
| GET | /autotagging | List auto-tag suggestions |
| POST | /autotagging/accept | Accept auto-tag |
| POST | /autotagging/reject | Reject auto-tag |
| Notifications | ||
| GET | /notifications | List notifications (legacy) |
| POST | /notifications | Create notification (legacy) |
| PUT | /notifications/{notificationID} | Update notification (legacy) |
| DELETE | /notifications/{notificationID} | Delete notification (legacy) |
| GET | /notifications/channels | List notification channels |
| POST | /notifications/channels | Create notification channel |
| PUT | /notifications/channels/{channelID} | Update notification channel |
| DELETE | /notifications/channels/{channelID} | Delete notification channel |
| GET | /notifications/subscriptions | List subscriptions |
| POST | /notifications/subscriptions | Create subscription |
| PUT | /notifications/subscriptions/{subID} | Update subscription |
| DELETE | /notifications/subscriptions/{subID} | Delete subscription |
| POST | /notifications/subscriptions/bulk | Bulk create/update subscriptions |
| GET | /notifications/event-types | List event types |
| GET | /notifications/email-preferences | Get email preferences |
| PUT | /notifications/email-preferences/{eventKey} | Update email preference |
| POST | /notifications/share/recommendation/{recID} | Share recommendation |
| Users & Teams | ||
| GET | /users | List users |
| POST | /users | Invite user |
| PATCH | /users/{email} | Update user |
| DELETE | /users/{email} | Remove user |
| GET | /teams | List teams |
| POST | /teams | Create team |
| GET | /teams/{teamID} | Get team |
| PUT | /teams/{teamID} | Update team |
| DELETE | /teams/{teamID} | Delete team |
| GET | /teams/{teamID}/members | List team members |
| POST | /teams/{teamID}/members | Add team member |
| DELETE | /teams/{teamID}/members/{email} | Remove team member |
| GET | /teams/{teamID}/resources | List team resources |
| POST | /teams/{teamID}/resources | Assign resource to team |
| DELETE | /teams/{teamID}/resources/{resourceUID} | Unassign resource |
| Roles & Permissions | ||
| GET | /roles | List roles |
| POST | /roles | Create role |
| GET | /roles/{roleID} | Get role |
| PUT | /roles/{roleID} | Update role |
| DELETE | /roles/{roleID} | Delete role |
| GET | /policies | List policies |
| GET | /assignments | List role assignments |
| POST | /assignments | Create assignment |
| PUT | /assignments/{assignmentID} | Update assignment |
| DELETE | /assignments/{assignmentID} | Delete assignment |
| GET | /permissions | Get current user permissions |
| GET | /users/{email}/permissions | Get user permissions |
| GET | /users/{email}/permissions/verify | Verify permission |
| Organizations & Audit | ||
| GET | /organisations | List organizations |
| POST | /organisations | Create organization |
| GET | /organisation | Get current organization |
| PUT | /organisation | Update organization |
| DELETE | /organisation | Delete organization |
| GET | /audit-logs | List audit logs |