Self-hosting Apidog
  1. Post Deployment
Self-hosting Apidog
  • Overview
  • Introduction
    • Obtaining Apidog On-Premises License
    • System Requirements
    • Data Privacy & Compliance
  • Deployment
    • Running Apidog on Docker
    • Running Apidog on Kubernetes
    • Running Apidog Multi-Container Deployment without Kubernetes
  • Post Deployment
    • Accessing Apidog Admin Panel
    • Accessing Apidog Web Interface
    • Installing Apidog On-Premises Client
  • Configurations
    • Environment Variables
    • Database Configuration
    • Storage Services Configuration
    • Git Connection Configuration
    • Authentication Providers
      • Using LDAP for Authentication
      • Using OKTA for Authentication
      • Using OAuth2.0 for Authentication
  • Maintenance & Upgrades
    • Updating Apidog
    • Backing up Apidog
    • License Renewal
    • System Design Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Post Deployment

Accessing Apidog Admin Panel

Once the Apidog server has been successfully deployed, the Admin Panel can be accessed via the URL:{BASE_URL}/admin.
For example:
https://api.example.com/admin
http://192.168.0.13/admin
To authenticate, use the credentials configured in the ADMIN_USERNAME and ADMIN_PASSWORD environment variables. Ensure these variables are securely defined in your environment before attempting to log in.

Overview#

The Overview section provides an at-a-glance summary of key metrics for your Apidog server instance, including the following:
Teams: Total teams currently configured in the system.
Projects: Total projects associated with your Apidog server.
Members: Total user accounts within your organization, including both active and inactive accounts.
Licenses: Active licenses available to users.
Valid until: The date when your active licenses are due to expire.
image.png
Note
The number of Members can exceed the number of Licenses due to the possibility of users being disabled (e.g., when they leave the organization). Licenses are tied to active users only, and thus do not reflect historical accounts or users who have been disabled.
To enhance the relevance of the statistics, an option is provided to exclude Teams with only a single member. This feature filters out personal teams created automatically for new users, typically containing only a sample project.
Additional metrics displayed in the Overview section include:
Test Coverage: Provides insights into the extent of testing coverage across your projects.
User Usage: Offers data on user interactions and activity within the Apidog environment, allowing for a more granular analysis of system engagement.

Managing Teams, Projects, and Users#

As an Administrator, you have access to view and manage basic details for all Teams, Projects, and Users within your Apidog instance.
Teams and Projects
Teams: Admins can view team details such as name, description, and member count.
Projects: Admins can view project details, including project name, description, and the associated team.
Users
Admins have the ability to perform various actions on user accounts, including:
Modify User Details: Update the username and registered email address of users.
Disable Users: Temporarily disable user accounts to free up licenses, allowing them to be reallocated to active users. Disabling a user does not delete their account; it only prevents them from accessing the system.
Reset User Passwords: Admins can initiate a password reset for users who may have forgotten or require a change in their login credentials.
Grant Super Admin Privileges: Admins can elevate a user to Super Admin status. Super Admins have unrestricted access to all data across the Apidog system, enabling them to manage teams and projects without needing to be a member of those teams. This role allows full administrative control via the desktop client.
Modified at 2025-12-08 05:12:40
Previous
Running Apidog Multi-Container Deployment without Kubernetes
Next
Accessing Apidog Web Interface
Built with