Skip to content

Canvus API

The Canvus API is a RESTful API on the Canvus server that enables automation and manipulation of content in Canvus by developers.

See the developer guide for how to use the API.

The API can be used to control Canvus clients that connect to an Canvus server which has enabled the API. By default, the client does not expose its state to the server. You can configure the client to disable API access, allow read-only access, or allow read/write access. Check the below section for more info.

Configuration

The API access to your Canvus client must be explicitly given to each server the client connects to. This can be done by modifying the client configuration file.

All API configuration parameters must be placed in a [server:] section in the server configuration file. The following settings are available in the section:

; Controls Rest API access to this client from the server.
; Valid values are:
;   * none - Do not expose this client to Rest API at all.
;   * ro - Allow read-only access to the client state
;   * rw - Allow read-write access to the client state
; DEFAULT: none
; rest-api-access=none

Note

The client must be restarted for the change to have an effect.

Info