v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WebApp
Web Apps

List the account's web applications.

This function lists the account's web applications and their current state.

get/WebApp/list

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list",
  "module": "WebApp",
  "result": {
    "data": [
      {
        "category": "server",
        "container_name": "my-app.bob.01",
        "db": {
          "env_keys": [
            "DB_NAME",
            "DB_HOST",
            "DB_PORT"
          ],
          "host": "localhost",
          "name": "example_my_app",
          "port": 3306
        },
        "deployname": "my-site",
        "domain": "my-app.example.com",
        "env": {
          "NODE_ENV": "production"
        },
        "framework": "nextjs",
        "last_deploy": {
          "deploy_id": "dp-20260612-0001",
          "result": "success",
          "timestamp": "2026-06-12T14:03:22.000Z"
        },
        "mode": "production",
        "name": "my-app",
        "package_manager": "npm",
        "runtime": "nodejs",
        "runtime_tag": "22",
        "source": {
          "branch": "main",
          "type": "git",
          "url": "https://github.com/example/my-app.git"
        },
        "staged": true,
        "status": "running",
        "url": "https://my-app.example.com"
      }
    ],
    "status": 1
  }
}