UWAGA: poniższa dokumentacja dotyczy nieakutalnej wersji API (2.0.0). Kliknij aby przejść do aktualnej dokumentacji.


Special methods

Most API modules provide one or more of the methods: Create, Read, Find, Update and Delete.

These method names are reserved and it's guaranteed that if a module has one of these, it will conform to the standards described below.


The Create method is used to create a new object (service, group, address etc.). It will expect the named object attributes in input. Create attributes are always a subset of the values returned by Read. It will output an id - the identifier of the newly created object.


The Read method returns information about an object based on its identifier (id). It expects an id and returns the object with this ID. Some Read methods may define additional with argument that is an array of extra items' symbols that you want to fetch with the object. For example, you can fetch a service type with the features supported by it (see ServiceType::Read).


Find is used to retrieve a list of objects of a type. Find can be supplied with the following arguments:

Find returns an object with fields:

For performance purposes, the objects returned by Find may not contain all fields that are returned by Read, however they will always be a subset of them. Refer to the module's documentation for an exact list of returned fields.


This method is used to modify an existing object with a specific ID.

It will always require the id argument to identify the object, and one or more object fields with the new values. Available fields are a subset of the fields returned by Read. Some fields (for example service type) are available to only when creating the object with Create and cannot be modified later (such as service's type). As a special case, calling Update with just the object's id checks if the object exists and modifies nothing.


This method requires the id argument containing the object's ID. It deletes the object. It may also delete other objects (for example, deleting a group deletes all its services), see the module's documentation for details.