Wp Admin REST API

🔐 Authentication

All API requests require authentication via Bearer tokens. Generate tokens from your dashboard under Settings → API Keys.

1. Generate API Key

Navigate to your Wp Admin dashboard and create a new API key with the required permissions (read, write, or admin).

2. Attach to Headers

Include your token in the Authorization header of every request.

Authorization: Bearer wp_live_8f4a2c1d9e7b3f5a6c8d0e2f4a6b8c0d

🔗 API Endpoints

Explore available resources and methods. Click tabs to view detailed specifications.

GET /sites

Retrieve a paginated list of all managed WordPress sites.

Parameter	Type	Required	Description
`page`	integer	Optional	Page number for pagination
`limit`	integer	Optional	Items per page (max 100)
`status`	string	Optional	Filter: active, paused, archived

Response Example (200 OK)

{
  "data": [
    {
      "id": "site_8x3k2m9p",
      "domain": "https://example.com",
      "status": "active",
      "wp_version": "6.4.2",
      "last_backup": "2024-03-15T14:30:00Z",
      "security_score": 98
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 10
  }
}

POST /sites

Parameter	Type	Required	Description
`domain`	string	Required	Full URL of the WordPress site
`wp_admin_user`	string	Required	Administrator username
`wp_admin_pass`	string	Required	Administrator password
`plan_id`	string	Optional	Management plan to apply

POST /sites/{site_id}/tasks

Create a new management task (backup, update, scan, etc.).

Parameter	Type	Required	Description
`site_id`	string	Required	Target site identifier
`type`	string	Required	backup, update_core, update_plugins, security_scan, optimize_db
`priority`	string	Optional	low, normal, high (default: normal)

// cURL Example
curl -X POST https://api.wpadmin.com/v1/sites/site_8x3k2m9p/tasks \\
  -H "Authorization: Bearer wp_live_..." \\
  -H "Content-Type: application/json" \\
  -d '{"type": "backup", "priority": "high"}'

GET /sites/{site_id}/reports

Fetch detailed maintenance and security reports for a site.

Parameter	Type	Required	Description
`site_id`	string	Required	Target site identifier
`period`	string	Optional	day, week, month, quarter, year
`format`	string	Optional	json, csv, pdf (default: json)

POST /webhooks

Parameter	Type	Required	Description
`url`	string	Required	HTTPS endpoint to receive payloads
`events`	array	Required	List of events: backup.completed, security.threat, update.failed
`secret`	string	Optional	For payload signature verification

{
  "id": "wh_92kd83js",
  "url": "https://your-app.com/wp-webhook",
  "events": ["backup.completed", "security.threat"],
  "status": "active",
  "created_at": "2024-03-15T10:00:00Z"
}

⏱️ Rate Limits

API requests are throttled to ensure platform stability.

Standard Tier100 req/min

Professional Tier500 req/min

Enterprise Tier2,000 req/min

Concurrent Connections20 / IP

Exceeding limits returns 429 Too Many Requests. Retry after the X-RateLimit-Reset header timestamp.

⚠️ Error Codes

Code	Description
`400`	Malformed request or invalid parameters
`401`	Missing or invalid authentication token
`403`	Insufficient permissions for this action
`404`	Requested resource not found
`422`	Validation error (check payload)
`429`	Rate limit exceeded
`500`	Internal server error