WebApp
Web Apps

List the account's web applications.

Changed on

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

get/WebApp/list

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

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": [
      {
        "build_command": "npm run build",
        "category": "server",
        "container_name": "my-app.bob.01",
        "db": {
          "env_keys": [
            "DB_NAME",
            "DB_HOST",
            "DB_PORT",
            "DB_USER",
            "DB_PASSWORD"
          ],
          "host": "localhost",
          "name": "example_my_app",
          "origin": "create",
          "port": 3306
        },
        "deployname": "my-site",
        "domain": "my-app.example.com",
        "env": {
          "NODE_ENV": "production"
        },
        "env_editable": true,
        "env_status": "ok",
        "framework": "nextjs",
        "health": {
          "action": "restart",
          "cause": "out_of_memory",
          "checked_at": "2026-06-12T14:03:22.000Z",
          "healthy_at": "2026-06-12T13:58:04.000Z",
          "incidents": 3,
          "memory": {
            "limit_bytes": 536870912,
            "oom_kills": 1,
            "peak_bytes": 186912768
          },
          "oom_incidents": 3,
          "restarts": 3,
          "state": "recovering"
        },
        "last_deploy": {
          "deploy_id": "dp-20260612-0001",
          "error_category": "build_failed",
          "error_detail": "The build command exited with code 1.",
          "error_phase": "build",
          "error_reason": "oom_suspected",
          "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,
        "startup_command": "npm run start",
        "status": "running",
        "url": "https://my-app.example.com"
      }
    ],
    "status": 1
  }
}

Changes

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      api operation id WebApp_list removed and replaced with WebApp-list

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status