PVQL API Versioning

PVQL API URLs should indicate a desired version. This is recommended to ensure that programs using the API will not break when upgrading. For example:

https://<SERVER>/api/0.1/<function>

https://<SERVER>/api/0.1/doc

wss://<SERVER>/api/0.1/ws

If a version is not specified, the API will choose the latest version available.

The meaning of the API version number is as follows:

• An unchanged version means the API is still the same or only received maintenance patches and is fully compatible with the previous one;
• An increment of MINOR (e.g. API 1.2 → API 1.3) means the API only added functionalities and is compatible with the previous one (e.g. a new function or optional arguments have been added);
• An increment of MAJOR (e.g. API 1.3 → API 2.0) means the API introduced breaking changes and is most likely incompatible with the previous one (e.g. a function has been removed or may require different arguments).

For more information on PVQL head over to https://api.accedian.io/.