General API Information and Usage
This is the documentation for the LiveZilla API V2 included from 5.2.5.x. Please read the contents of this page carefully.
Unlike other (RESTful) APIs, the LiveZilla API is solely based on POST and JSON. We do not make use of GET, PUT, DELETE or custom HEADER calls and statements to ensure highest availability - even on shared hosting platforms with limited configuration options.
LiveZilla V2 API calls must be HTTP POST requests targeting:
http(s)://{yourdomain}/livezilla/api/v2/api.php
What's Included
At this time, the API is limited to the basic LiveZilla core objects that can be read, added or deleted depending on the API calls you make.
We plan to extend the API depending on the feedback we receive from the users. If you find anything missing please let us know and we will add
the missing structures right away.
Examples
If you like to start without much reading check our API examples section where we have different code snippets with ready-to-use code.
Authentication and Security
All API calls must include the POST parameters p_user and p_pass to authenticate against the LiveZilla server.
Any LiveZilla operator login information can be used for API call. Permission for API calls must be granted under:
User Management -> Operators -> Operator -> Permission -> General
For security reasons it's recommended practice to:
- Use HTTPS for all connections to your server
- Configure your LiveZilla to require HTTPS (Server Configuration -> Security -> Require HTTPS)
- Configure an IP Range for your Operator (API) accounts (User Management -> Operators -> Operator -> Security)
Required Authentication Parameters
These POST parameters must be passed with every API Call.
| Name |
POST Key |
Type |
Required |
Comment |
Example |
|
| User | p_user | string | Yes | API Authentication User | administrator | |
| Password | p_password | string | Yes | API Authentication Password (md5 encoded) | md5('password') | |
Optional Parameters
These optional POST parameters can be passed with every API Call.
| Name |
POST Key |
Type |
Required |
Comment |
Example |
|
| JSON_Pretty | p_json_pretty | int | No | Activates PHP JSON Pretty Print output | 1 | |
Something missing?
If you find anything missing please let us know and we will add
the missing structures right away. Thanks.
