Skip to content

REST API#

Important

Available as of version 1.6.0.

The REST API makes it possible to retrieve and set certain parameters and functions of a COMtrexx.

Thus, for example, own applications can be used to read in the status of the COMtrexx and its endpoints (telephones, SIP trunks, etc.) and to configure certain functions.

Documentation#

The documentation of the REST API is available as a YAML file: ctx-api-v1.yml. The YAML file corresponding to the firmware version can be downloaded from the respective COMtrexx as follows:

  1. Open the web interface of the COMtrexx.
  2. Log in as an administrator.
  3. Enter the following in the address bar https://[COMtrexx]/api/system/api for example https://192.168.0.248/api/system/api

Access#

The REST API can only be accessed via a secure connection (Port 443).

[COMtrexx]/api/[command] executes commands using the current version of the REST API.

[COMtrexx]/api/v1/[command] executes commands using the specified version of the REST API (here: v1).

HTTP Methods#

GET requests the specified object from the server.

POST creates a new object.

DELETE deletes the specified object.

PUT changes the specified object.

  • PUT properties not sent -> Properties are not updated

  • PUT properties with value null -> Properties are set to a default value if possible or contents are deleted. Mandatory fields are not deleted.