> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/panel-api/resources.md). # Resources This page indexes the Admin Panel API's operations by resource family. Each family has its own page with the full parameter and response schema for every operation, plus a panel for sending a test request directly from the documentation. Use this page to find the family you need and jump straight to its operations. ## Authentication Most operations require a session hash in the `Authorization` header. See [Admin Panel authentication](/docs/navixy-api/panel-api/authentication.md) for how to obtain one and use it in requests. ## Base URL The Admin Panel API is accessible via the `panel/` subsection of the API URL. The URLs for different Navixy platforms are as follows: * European Navixy ServerMate platform: `https://api.eu.navixy.com/v2/panel/` * American Navixy ServerMate platform: `https://api.us.navixy.com/v2/panel/` * Middle East Navixy ServerMate platform: `https://api.me.navixy.com/v2/panel/` * Self-hosted (On-Premise) installations: `https://api.your_domain/panel/` For example, an `account/auth` call on the European platform uses `https://api.eu.navixy.com/v2/panel/account/auth`. The query-string and form-encoded body transports both percent-encode their values. Any character in those values outside ASCII codes 32 to 127 must be [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding). ## OpenAPI specification Every operation on every family page is generated from a single OpenAPI 3.1 specification, so the parameter tables, response schemas, and status codes are the specification rendered rather than prose written by hand. You can download the raw specification as [JSON](https://raw.githubusercontent.com/Navixy/navixy-public-docs/refs/heads/main/api-docs/platform-api/panel-api/reference/Admin_Panel.json) to generate a client, load into an API tool, or hand to an AI agent. Treat it as the technical source of truth. ## Resource families Every operation belongs to one of the 10 resource families below. For how dealers, sub-dealers, users, trackers, and plans relate to each other, see [Key concepts](/docs/navixy-api/panel-api/getting-started.md#key-concepts). | Family | Operations for | | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [Account](/docs/navixy-api/panel-api/resources/account.md) | Session lifecycle and permission checks | | [Dealer](/docs/navixy-api/panel-api/resources/dealer.md) | Dealer profile, activation codes, and panel settings | | [Subpaas](/docs/navixy-api/panel-api/resources/subpaas.md) | Sub-dealer accounts and their credentials | | [User](/docs/navixy-api/panel-api/resources/user.md) | User accounts, balances, menu presets, and multi-factor authentication | | [Tracker](/docs/navixy-api/panel-api/resources/tracker.md) | Devices, clones, settings, and plans | | [Tariff](/docs/navixy-api/panel-api/resources/tariff.md) | Service plans and device registration defaults | | [Order](/docs/navixy-api/panel-api/resources/order.md) | Equipment orders | | [Gateways](/docs/navixy-api/panel-api/resources/gateways.md) | Email gateways | | [Timezone](/docs/navixy-api/panel-api/resources/timezone.md) | Supported time zones | ## Quick endpoint reference The tables below list every operation grouped by family. Each endpoint links to the page where its full schema and test panel live. ### Account | Endpoint | Method | Description | | ---------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------------- | | [`/panel/account/auth`](/docs/navixy-api/panel-api/resources/account.md#post-panel-account-auth) | POST | Authenticate a dealer and open a panel session. | | [`/panel/account/get_permissions`](/docs/navixy-api/panel-api/resources/account.md#post-panel-account-get_permissions) | POST | Get the permissions granted to the current session. | | [`/panel/account/logout`](/docs/navixy-api/panel-api/resources/account.md#post-panel-account-logout) | POST | End the current session. | ### Dealer | Endpoint | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------------------------------- | | [`/panel/dealer/get_info`](/docs/navixy-api/panel-api/resources/dealer.md#post-panel-dealer-get_info) | POST | Get the current dealer's profile information. | | [`/panel/dealer/activation_code/create`](/docs/navixy-api/panel-api/resources/dealer/activation_code.md#post-panel-dealer-activation_code-create) | POST | Generate device activation codes. | | [`/panel/dealer/activation_code/list`](/docs/navixy-api/panel-api/resources/dealer/activation_code.md#post-panel-dealer-activation_code-list) | POST | List existing activation codes. | | [`/panel/dealer/activation_code/update`](/docs/navixy-api/panel-api/resources/dealer/activation_code.md#post-panel-dealer-activation_code-update) | POST | Update the status of activation codes. | | [`/panel/dealer/password/update`](/docs/navixy-api/panel-api/resources/dealer/password.md#post-panel-dealer-password-update) | POST | Update the dealer's password. | | [`/panel/dealer/settings/image/upload`](/docs/navixy-api/panel-api/resources/dealer/settings/image.md#post-panel-dealer-settings-image-upload) | POST | Upload a branding image. | | [`/panel/dealer/settings/image/delete`](/docs/navixy-api/panel-api/resources/dealer/settings/image.md#post-panel-dealer-settings-image-delete) | POST | Delete a branding image. | | [`/panel/dealer/settings/notification/read`](/docs/navixy-api/panel-api/resources/dealer/settings/notification.md#post-panel-dealer-settings-notification-read) | POST | Read notification settings. | | [`/panel/dealer/settings/notification/update`](/docs/navixy-api/panel-api/resources/dealer/settings/notification.md#post-panel-dealer-settings-notification-update) | POST | Update notification settings. | | [`/panel/dealer/settings/service/read`](/docs/navixy-api/panel-api/resources/dealer/settings/service.md#post-panel-dealer-settings-service-read) | POST | Read service settings. | | [`/panel/dealer/settings/service/update`](/docs/navixy-api/panel-api/resources/dealer/settings/service.md#post-panel-dealer-settings-service-update) | POST | Update service settings. | ### Subpaas | Endpoint | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------ | | [`/panel/subpaas/list`](/docs/navixy-api/panel-api/resources/subpaas.md#post-panel-subpaas-list) | POST | List sub-dealers under the current dealer. | | [`/panel/subpaas/read`](/docs/navixy-api/panel-api/resources/subpaas.md#post-panel-subpaas-read) | POST | Read a single sub-dealer. | | [`/panel/subpaas/create`](/docs/navixy-api/panel-api/resources/subpaas.md#post-panel-subpaas-create) | POST | Create a sub-dealer. | | [`/panel/subpaas/update`](/docs/navixy-api/panel-api/resources/subpaas.md#post-panel-subpaas-update) | POST | Update a sub-dealer. | | [`/panel/subpaas/password/change`](/docs/navixy-api/panel-api/resources/subpaas/password.md#post-panel-subpaas-password-change) | POST | Change a sub-dealer's password. | | [`/panel/subpaas/session/create`](/docs/navixy-api/panel-api/resources/subpaas/session.md#post-panel-subpaas-session-create) | POST | Open a session as a sub-dealer. | ### User | Endpoint | Method | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------ | | [`/panel/user/list`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-list) | POST | List users. | | [`/panel/user/read`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-read) | POST | Read a single user. | | [`/panel/user/export`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-export) | POST | Export users. | | [`/panel/user/change_password`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-change_password) | POST | Change a user's password. | | [`/panel/user/corrupt`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-corrupt) | POST | Corrupt a user account, marking it and its data as unusable. | | [`/panel/user/session/create`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-session-create) | POST | Open a session as a user. | | [`/panel/user/transaction/list`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-transaction-list) | POST | List a user's balance transactions. | | [`/panel/user/transaction/change_balance`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-transaction-change_balance) | POST | Change a user's balance. | | [`/panel/user/create`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-create) | POST | Create a user. | | [`/panel/user/update`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-update) | POST | Update a user. | | [`/panel/user/upload`](/docs/navixy-api/panel-api/resources/user.md#post-panel-user-upload) | POST | Bulk-create users from a spreadsheet. | | [`/panel/user/menu/preset/list`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-preset-list) | POST | List menu presets. | | [`/panel/user/menu/preset/create`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-preset-create) | POST | Create a menu preset. | | [`/panel/user/menu/preset/update`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-preset-update) | POST | Update a menu preset. | | [`/panel/user/menu/preset/delete`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-preset-delete) | POST | Delete a menu preset. | | [`/panel/user/menu/preset/assign`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-preset-assign) | POST | Assign a menu preset to a user. | | [`/panel/user/menu/item/list`](/docs/navixy-api/panel-api/resources/user/preset.md#post-panel-user-menu-item-list) | POST | List available menu items. | | [`/panel/user/mfa/settings/update`](/docs/navixy-api/panel-api/resources/user/mfa-settings.md#post-panel-user-mfa-settings-update) | POST | Update a user's MFA settings. | | [`/panel/user/mfa/settings/default/read`](/docs/navixy-api/panel-api/resources/user/mfa-settings.md#post-panel-user-mfa-settings-default-read) | POST | Read the default MFA settings. | | [`/panel/user/mfa/settings/default/update`](/docs/navixy-api/panel-api/resources/user/mfa-settings.md#post-panel-user-mfa-settings-default-update) | POST | Update the default MFA settings. | ### Tracker | Endpoint | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------ | ------------------------------------------------------------------- | | [`/panel/tracker/list`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-list) | POST | List trackers. | | [`/panel/tracker/read`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-read) | POST | Read a single tracker. | | [`/panel/tracker/clone`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-clone) | POST | Create a clone of a tracker for another user. | | [`/panel/tracker/batch_clone`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-batch_clone) | POST | Clone up to 1,000 trackers to one user in a single request. | | [`/panel/tracker/delete_clone`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-delete_clone) | POST | Delete a tracker clone. | | [`/panel/tracker/batch_delete_clones`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-batch_delete_clones) | POST | Delete up to 500 tracker clones in one request. | | [`/panel/tracker/corrupt`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-corrupt) | POST | Corrupt a tracker's device, with no undo. | | [`/panel/tracker/move`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-move) | POST | Move a tracker to another user. | | [`/panel/tracker/register_retry`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-register_retry) | POST | Retry a tracker's device registration. | | [`/panel/tracker/settings/update`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-settings-update) | POST | Update a tracker's settings. | | [`/panel/tracker/source/update`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-source-update) | POST | Update a tracker's underlying device. | | [`/panel/tracker/tariff/change`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-tariff-change) | POST | Change a tracker's service plan. | | [`/panel/tracker/console/connect`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-console-connect) | POST | Open a console connection to a tracker's device. | | [`/panel/tracker/active/history/list`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-active-history-list) | POST | Report how many trackers were active in each month of a date range. | | [`/panel/tracker/raw_command/send`](/docs/navixy-api/panel-api/resources/tracker.md#post-panel-tracker-raw_command-send) | POST | Send a raw command to a tracker's device. | ### Tariff | Endpoint | Method | Description | | ------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------- | | [`/panel/tariff/list`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-list) | POST | List plans. | | [`/panel/tariff/read`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-read) | POST | Read a single plan. | | [`/panel/tariff/create`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-create) | POST | Create a plan. | | [`/panel/tariff/update`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-update) | POST | Update a plan. | | [`/panel/tariff/defaults/read`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-defaults-read) | POST | Read the per-device-type plan defaults. | | [`/panel/tariff/defaults/update`](/docs/navixy-api/panel-api/resources/tariff.md#post-panel-tariff-defaults-update) | POST | Update the per-device-type plan defaults. | ### Order | Endpoint | Method | Description | | ------------------------------------------------------------------------------------------ | ------ | ------------------------ | | [`/panel/order/read`](/docs/navixy-api/panel-api/resources/order.md#post-panel-order-read) | POST | Read an equipment order. | ### Gateways | Endpoint | Method | Description | | --------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------ | | [`/panel/gateways/email/list`](/docs/navixy-api/panel-api/resources/gateways.md#post-panel-gateways-email-list) | POST | List available email gateways. | ### Timezone | Endpoint | Method | Description | | --------------------------------------------------------------------------------------------------- | ------ | -------------------------------------------- | | [`/panel/timezone/list`](/docs/navixy-api/panel-api/resources/timezone.md#post-panel-timezone-list) | POST | List the platform-wide supported time zones. | ## Support For questions and support, contact the [Navixy developer support team](/docs/navixy-api/general/contacts.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/panel-api/resources.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.