OpenAdmin API Documentation

OpenAdmin API can be used to manage options available from the OpenAdmin interface: hosting plans, accounts, domains, services, etc. All API endpoints require Bearer JWT authentication.

To generate a token for use with the endpoints, send a POST request to /api/ using your OpenAdmin username and password:

curl -X POST "https://OPENADMIN_DOMAIN_OR_IP:2087/api/" && \
  -H "Content-Type: application/json" -d '{"username":"OPENADMIN_USERNAME","password":"OPENADMIN_PASSWORD"}'

We recommend creating a separate admin user dedicated solely to API usage. This way, you can quickly suspend or delete that account if its credentials are ever compromised.

Example response with the token is:

{"access_token":"eyJhbGciOiJIUzI1NiIsInRs4CI6IkpXVCJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTc4MDc0OTkwOCwianRpIjoiZDcwZmY2NmEtNDNiOC00OGZkLThiMWEtZDIwYWUwMDNhNjEyIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6Im9wc3VwcG9ydCIsIm5iZiI6MTc4MDc0OTkwOCwiY3NyZiI6IjZlOGRmNGVmLTA0MjktNGNkYy1hNTg5LTJkYzUwMDk2ZDI2NSIsI3V4cCI6MTc4M33c1MDgwOH0.WLQ8rsVOF6pQg07i1fI1lXfd8_cCmryiOjGqg8zgOmw"}

This token must be sent in header for all other API endpoints:

-H "Authorization: Bearer YOUR_JWT_TOKEN" -H "Content-Type: application/json"

💡 Hint: Use opencli api list command to view usage examples for all the endpoints available on your OpenPanel version.

Users​

List All Accounts​

GET /api/users

[
  {
    "username": "stefan",
    "email": "stefan@pejcic.rs",
    "plan_name": "default_plan_nginx"
  }
]

Create Account​

POST /api/users Request Body:

{
  "email": "stefan@pejcic.rs",
  "username": "stefan",
  "password": "s32dsasaq",
  "plan_name": "default_plan_nginx"
}

Response:

{
  "response": {
    "message": "Successfully added user stefan password: s32dsasaq"
  },
  "success": true
}

Get Single Account​

GET /api/users/{username}

Suspend / Unsuspend / Change Password​

PATCH /api/users/{username} Request Body Example:

{
  "action": "suspend",
  "password": "NEW_PASSWORD_HERE"
}

Change Plan​

PUT /api/users/{username} Request Body:

{
  "plan_name": "default_plan_nginx"
}

Delete Account​

DELETE /api/users/{username}

Autologin to User Account​

CONNECT /api/users/{username}

List Users with Dedicated IPs​

GET /api/ips

Plans​

List All Plans​

GET /api/plans Response:

{
  "plans": [
    {
      "id": 1,
      "name": "ubuntu_nginx_mysql",
      "description": "Unlimited disk space and Nginx",
      "bandwidth": 100,
      "cpu": "1",
      "ram": "1g",
      "disk_limit": "10 GB",
      "storage_file": "0 GB",
      "inodes_limit": 1000000,
      "db_limit": 0,
      "domains_limit": 0,
      "websites_limit": 10,
      "docker_image": "openpanel/nginx"
    }
  ]
}

Get Single Plan​

GET /api/plans/{plan_id}

Domains​

List All Domains​

GET /api/domains

Add Domain​

POST /api/domains/new Request Body:

{
  "username": "current_user",
  "domain": "example.com",
  "docroot": "/var/www/html/example.com"
}

Suspend Domain​

POST /api/domains/suspend/{domain}

Unsuspend Domain​

POST /api/domains/unsuspend/{domain}

Delete Domain​

POST /api/domains/delete/{domain}

Usage​

API Usage Info​

GET /api/usage

Current Usage Stats​

GET /api/usage/stats Response:

{
  "usage_stats": "{\"timestamp\": \"2024-09-03\", \"users\": 1, \"domains\": 2, \"websites\": 0}"
}

CPU Usage​

GET /api/usage/cpu Response Example:

{
  "core_0": 0,
  "core_1": 0
}

Memory Usage​

GET /api/usage/memory

Disk Usage Per User​

GET /api/usage/disk

Server Disk Usage​

GET /api/usage/server Response Example:

[
  {
    "device": "/dev/vda1",
    "mountpoint": "/",
    "fstype": "ext4",
    "total": 123690532864,
    "used": 63366230016,
    "free": 60307525632,
    "percent": 51.2
  }
]

System​

Get System Information​

GET /api/system Response Example:

{
  "hostname": "stefi",
  "os": "Ubuntu 24.04 LTS",
  "time": "2024-09-04 15:09:16",
  "kernel": "6.8.0-36-generic",
  "cpu": "DO-Premium-Intel(x86_64)",
  "openpanel_version": "0.2.7",
  "running_processes": 178,
  "package_updates": 98,
  "uptime": "18905"
}

Services​

List Monitored Services​

GET /api/services

Edit Services List​

PUT /api/services Request Body Example:

{
  "service1": { "name": "Service One", "status": "active" },
  "service2": { "name": "Service Two", "status": "inactive" }
}

Check Status of Services​

GET /api/services/status

Start Service​

POST /api/service/start/{service_name}

Restart Service​

POST /api/service/restart/{service_name}

Stop Service​

POST /api/service/stop/{service_name}

Notifications​

List Notifications​

GET /api/notifications

Response Example:

[
  { "title": "Update available", "message": "New package updates available." }
]