Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
my.nethesis.it logo my.nethesis.it logo dark

Topics

  • Introduction
  • Servers
  • Authentication

Endpoints

  • Backend - Authentication
    • /auth/exchange - Exchange Logto token for custom JWT POST
    • /auth/refresh - Refresh access token POST
    • /auth/logout - Logout user POST
  • Backend - Me
    • /me - Get current user information GET
    • /me/change-password - Change current user password POST
    • /me/change-info - Change current user information POST
    • /me/avatar - Upload current user avatar PUT
    • /me/avatar - Delete current user avatar DELETE
  • Backend - Impersonation
    • /impersonate/consent - Get impersonation consent status GET
    • /impersonate/consent - Enable impersonation consent POST
    • /impersonate/consent - Disable impersonation consent DELETE
    • /impersonate - Start impersonation (permission-based access) POST
    • /impersonate - Exit impersonation mode DELETE
    • /impersonate/status - Check current impersonation status GET
  • Backend - Impersonation Sessions
    • /impersonate/sessions - List impersonation sessions GET
    • /impersonate/sessions/{session_id} - Get details for specific session GET
    • /impersonate/sessions/{session_id}/audit - Get audit logs for specific session GET
  • Backend - Users
    • /users - List users GET
    • /users - Create user POST
    • /users/{id} - Get single user GET
    • /users/{id} - Update user PUT
    • /users/{id} - Delete user DELETE
    • /users/{id}/password - Reset user password PATCH
    • /users/{id}/avatar - Upload user avatar (admin) PUT
    • /users/{id}/avatar - Delete user avatar (admin) DELETE
    • /users/{id}/suspend - Suspend user PATCH
    • /users/{id}/reactivate - Reactivate suspended user PATCH
    • /users/{id}/restore - Restore soft-deleted user PATCH
    • /users/{id}/destroy - Permanently delete user DELETE
  • Backend - Users Stats
    • /users/totals - Get users totals GET
    • /users/trend - Get users trend data GET
  • Backend - Users Import/Export
    • /users/export - Export users to CSV or PDF GET
    • /users/import/template - Download CSV import template GET
    • /users/import/validate - Validate CSV file for user import POST
    • /users/import/confirm - Execute validated user import POST
  • Backend - Distributors
    • /distributors - List distributors GET
    • /distributors - Create distributor POST
    • /distributors/{id} - Get single distributor GET
    • /distributors/{id} - Update distributor PUT
    • /distributors/{id} - Delete distributor DELETE
    • /distributors/{id}/stats - Get distributor statistics GET
    • /distributors/{id}/suspend - Suspend distributor PATCH
    • /distributors/{id}/reactivate - Reactivate distributor PATCH
    • /distributors/{id}/restore - Restore soft-deleted distributor PATCH
    • /distributors/{id}/destroy - Permanently delete distributor DELETE
  • Backend - Distributors Stats
    • /distributors/totals - Get distributors totals GET
    • /distributors/trend - Get distributors trend data GET
  • Backend - Distributors Import/Export
    • /distributors/export - Export distributors to CSV or PDF GET
    • /distributors/import/template - Download CSV import template GET
    • /distributors/import/validate - Validate CSV for distributor import POST
    • /distributors/import/confirm - Execute validated distributor import POST
  • Backend - Resellers
    • /resellers - List resellers GET
    • /resellers - Create reseller POST
    • /resellers/{id} - Get single reseller GET
    • /resellers/{id} - Update reseller PUT
    • /resellers/{id} - Delete reseller DELETE
    • /resellers/{id}/stats - Get reseller statistics GET
    • /resellers/{id}/suspend - Suspend reseller PATCH
    • /resellers/{id}/reactivate - Reactivate reseller PATCH
    • /resellers/{id}/restore - Restore soft-deleted reseller PATCH
    • /resellers/{id}/destroy - Permanently delete reseller DELETE
  • Backend - Resellers Stats
    • /resellers/totals - Get resellers totals GET
    • /resellers/trend - Get resellers trend data GET
  • Backend - Resellers Import/Export
    • /resellers/import/template - Download CSV import template GET
    • /resellers/import/validate - Validate CSV for reseller import POST
    • /resellers/import/confirm - Execute validated reseller import POST
    • /resellers/export - Export resellers to CSV or PDF GET
  • Backend - Customers
    • /customers - List customers GET
    • /customers - Create customer POST
    • /customers/{id} - Get single customer GET
    • /customers/{id} - Update customer PUT
    • /customers/{id} - Delete customer DELETE
    • /customers/{id}/stats - Get customer statistics GET
    • /customers/{id}/suspend - Suspend customer PATCH
    • /customers/{id}/reactivate - Reactivate customer PATCH
    • /customers/{id}/restore - Restore soft-deleted customer PATCH
    • /customers/{id}/destroy - Permanently delete customer DELETE
  • Backend - Customers Stats
    • /customers/totals - Get customers totals GET
    • /customers/trend - Get customers trend data GET
  • Backend - Customers Import/Export
    • /customers/export - Export customers to CSV or PDF GET
    • /customers/import/template - Download CSV import template GET
    • /customers/import/validate - Validate CSV for customer import POST
    • /customers/import/confirm - Execute validated customer import POST
  • Backend - Systems
    • /systems - List systems GET
    • /systems - Create system POST
    • /systems/{id} - Get single system GET
    • /systems/{id} - Update system PUT
    • /systems/{id} - Delete system DELETE
    • /systems/{id}/restore - Restore soft-deleted system PATCH
    • /systems/{id}/destroy - Permanently delete system DELETE
    • /systems/{id}/suspend - Suspend system PATCH
    • /systems/{id}/reactivate - Reactivate suspended system PATCH
    • /systems/{id}/regenerate-secret - Regenerate system secret POST
    • /systems/{id}/reachability - Check if system web UI is reachable GET
    • /systems/register - Register system with system_secret POST
  • Backend - Systems Stats
    • /systems/totals - Get systems status summary GET
    • /systems/trend - Get systems trend data GET
    • /systems/export - Export systems to CSV or PDF GET
  • Backend - Systems Inventory
    • /systems/{id}/inventory - Get system inventory history GET
    • /systems/{id}/inventory/latest - Get latest system inventory GET
    • /systems/{id}/inventory/{inventory_id} - Get a specific inventory record GET
    • /systems/{id}/inventory/changes - Get inventory changes summary GET
    • /systems/{id}/inventory/changes/latest - Get latest inventory changes GET
    • /systems/{id}/inventory/diffs - Get inventory diffs GET
    • /systems/{id}/inventory/diffs/latest - Get latest inventory diffs batch GET
    • /systems/{id}/inventory/timeline - Get inventory timeline grouped by date GET
  • Backend - Applications
    • /applications - List applications GET
    • /applications/{id} - Get single application GET
    • /applications/{id} - Update application PUT
    • /applications/{id} - Delete application DELETE
    • /applications/{id}/assign - Assign organization PATCH
    • /applications/{id}/unassign - Remove organization PATCH
  • Backend - Applications Stats
    • /applications/totals - Get application statistics GET
    • /applications/summary - Get applications grouped by type GET
    • /applications/trend - Get applications trend data GET
  • Backend - Metadata
    • /third-party-applications - Get third-party applications GET
    • /organization-roles - Get all organization roles GET
    • /organizations - Get available organizations GET
    • /roles - Get all user roles GET
  • Backend - Filters
    • /filters/systems - Get aggregated system filters GET
    • /filters/applications - Get aggregated application filters GET
    • /filters/users - Get aggregated user filters GET
  • Backend - Rebranding
    • List rebrandable products GET
    • Enable rebranding for an organization PATCH
    • Disable rebranding for an organization PATCH
    • Get rebranding status for an organization GET
    • Get rebranding products for an organization GET
    • Upload rebranding assets for a product PUT
    • Delete all rebranding assets for a product DELETE
    • Get a rebranding asset binary GET
    • Delete a single rebranding asset DELETE
  • Backend - Public
    • /public/users/{id}/avatar - Get user avatar image GET
  • Backend - User
    • /user/permissions - Get user permissions (OAuth2/OIDC) GET
    • /user/profile - Get user profile (OAuth2/OIDC) GET
  • Backend - Validators
    • /validators/vat/{entity_type} - Validate VAT number GET
  • Backend - Health
    • /health - Health check GET
  • Backend - Alerts
    • /systems/{id}/alerts - Get active alerts for a system GET
    • /systems/{id}/alerts/silences - List active silences for a system GET
    • /systems/{id}/alerts/silences - Create a silence for a system alert POST
    • /systems/{id}/alerts/silences/{silence_id} - Get a single silence GET
    • /systems/{id}/alerts/silences/{silence_id} - Update a silence PUT
    • /systems/{id}/alerts/silences/{silence_id} - Disable a system alert silence DELETE
    • /systems/{id}/alerts/history - Get system alert history GET
    • Get alert totals GET
    • Get alert history trend GET
    • Aggregate alert statistics GET
    • Org-level paginated alert history GET
    • Get current alerting configuration GET
    • Configure alert routing POST
    • Disable all alerts DELETE
    • List active alerts GET
  • Collect - Systems
    • /systems/info - Get system info GET
    • /systems/inventory - Collect system inventory POST
    • /systems/heartbeat - System heartbeat POST
    • /systems/backups - List backups for the authenticated system GET
    • /systems/backups - Upload a configuration backup POST
    • /systems/backups/{id} - Download a backup GET
    • /systems/backups/{id} - Delete a backup DELETE
  • Collect - Rebranding
    • Get system rebranding configuration GET
    • Get a rebranding asset binary for the system GET
  • Collect - Alerting
    • List active alerts GET
    • Push alerts POST
    • List silences GET
    • Create or update a silence POST
    • Get a silence GET
    • Delete a silence DELETE
    • Receive alert history webhook POST
  • Backend - Systems Backups
    • /systems/{id}/backups - List configuration backups for a system GET
    • /systems/{id}/backups/{backup_id}/download - Issue a short-lived download URL GET
    • /systems/{id}/backups/{backup_id} - Delete a stored backup DELETE
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
my.nethesis.it logo my.nethesis.it logo dark

Backend - Systems Backups

Ask AI
  • Open in ChatGPT
  • Open in Claude
  • View as Markdown
  • Copy as Markdown