v2.4.1

Wp Admin Documentation

Complete guide to managing, securing, and optimizing your WordPress infrastructure using the Wp Admin platform.

Platform Overview

Wp Admin is an enterprise-grade WordPress management platform designed for developers, agencies, and businesses. It provides centralized control over multiple WordPress installations with automated security, performance optimization, backup management, and real-time monitoring.

â„šī¸

Prerequisites

Before getting started, ensure you have SSH access to your server, a valid Wp Admin license key, and at least one WordPress installation running version 6.0+.

Key Capabilities

  • Centralized Dashboard - Monitor unlimited sites from a single interface
  • Automated Security - Real-time threat detection, firewall management, and malware scanning
  • Staging & Deployment - Push changes safely with one-click staging environments
  • API-First Architecture - Full programmatic control via RESTful endpoints

Quick Start Guide

Get your first site connected to Wp Admin in under 5 minutes. Follow these steps to install the client agent and authenticate with our servers.

1. Install the Wp Admin Agent

Access your server via SSH and run the installation script with sudo privileges:

bash
curl -sSL https://agent.wpadmin.com/install.sh | sudo bash

2. Authenticate & Register

Register your site using your license key. The agent will automatically detect your WordPress installation and create a secure tunnel.

bash
wpadmin-cli auth register --key=YOUR_LICENSE_KEY --site-url=https://example.com
💡

Pro Tip

Use the --dry-run flag to validate your configuration before committing changes to your live environment.

API Authentication

Wp Admin uses Bearer token authentication for all API requests. Generate your tokens from the Dashboard under Settings → API Keys.

Request Format

http
GET /v2/sites HTTP/1.1
Host: api.wpadmin.com
Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
X-WPAdmin-Version: 2.4

Token Permissions

Scope Description Allowed Actions
sites:read Read-only access to site data List sites, view metrics, read logs
sites:write Modify site configurations Update plugins, change settings, deploy
backups:manage Backup operations Create, restore, schedule backups
admin:full Administrative access All actions, user management, billing

Core API Endpoints

The Wp Admin REST API follows standard HTTP conventions. All responses return JSON payloads with consistent error formatting.

List All Sites

http
GET /v2/sites?limit=50&offset=0&status=active

Response Format

json
{
  "data": [
    {
      "id": "site_8f4a2c",
      "url": "https://example.com",
      "wp_version": "6.4.2",
      "status": "healthy",
      "last_scan": "2025-01-15T14:30:00Z",
      "metrics": {
        "uptime": 99.98,
        "load_time": 0.84,
        "security_score": 94
      }
    }
  ],
  "pagination": {
    "total": 127,
    "limit": 50,
    "offset": 0,
    "next": "/v2/sites?limit=50&offset=50"
  }
}
âš ī¸

Rate Limits

API requests are limited to 1,000 calls per minute per token. Exceeding this limit returns a 429 Too Many Requests status with a retry-after header.

Troubleshooting

Common issues and their solutions for Wp Admin installations and API integrations.

Connection Timeout Errors

If you receive ECONNREFUSED or timeout errors when initializing the agent, verify that your server allows outbound traffic on ports 443 and 8443.

bash
sudo wpadmin-cli network diagnose --verbose

Plugin Conflict Resolution

Wp Admin may flag performance issues when certain caching or security plugins conflict with our agent. Use the compatibility checker:

bash
wpadmin-cli scan conflicts --site-id=site_8f4a2c

Backup Restoration Failures

Ensure your database user has the SUPER and TRIGGER privileges. InnoDB strict mode may also block imports if foreign key constraints are violated.