cerberus-docs / docs / updater / api.rst

Full commit

Cerberus Updater API

__construct(array $params)

Possible parameters:

hostname (string)

update_access_key (string)

api (string)

set_access_key(string $key)

The access key for your site.

set_hostname(string $host)

The hostname of your site.


Set the async mode for updates.

set_api(string $api)

You can change the target of the update method if you want to use a testing service in development.

encrypt(string $data)

Encrypt your JSON-encoded data ready to send to Cerberus.

update(string $encrypted, [int $timeout])

Send your data to Cerberus. The default timeout for the update is 1 second.