API reference

Endpoints

Get consumers

This will return a list of all consumers.

Create a new consumer

Create a new consumer based on the specified fields.

Delete consumer

Delete the specified consumer.

Get consumer by name

Get information about the specified consumer.

Update consumer

Update the specified consumer. This is useful when updating consumer specific attributes, such as consumer email address.

Get consumer modules

Returns a list with the configured modules for the specified consumer.

Enable module for a consumer

Enables a module for the specified consumer.

Remove module from a consumer

Removes a module from the specified consumer.

Get module by name

Returns the configuration of a module for the specified consumer.

Update consumer module

Updates the configuration of a module enabled for this consumer.

Get endpoints

This will return a list of all endpoints.

Create a new endpoint

Create a new endpoint based on the specified fields.

Delete endpoint

This will delete an endpoint with the specified name.

Get endpoint by name

This will return an endpoint with the specified name.

Update endpoint

Updates the properties of an existing endpoint.

Get endpoint modules

This will return a list of all modules that have been configured for this endpoint.

Enable module for endpoint

This will enable the specified module for this endpoint.

Remove module from endpoint

Remove a configured module from this endpoint.

Get module

This will return the configuration of the specified module for this endpoint.

Update module run order

This will update the order in which a module will be run. The higher the number the further the module will be in the run queue. Should several modules have the same order, their run order is not guaranteed; it is up to the runtime to pick.

Add consumer to module configuration

This will add the specified consumer to the configuration of the given module.

Delete a consumer configuration

This will delete the configuration of a module for the specified consumer.

Update a consumer configuration

This will update the configuration of a module for the specified consumer.

Update default configuration

This will update the default configuration of a module for the specified endpoint.

Add tag to module configuration.

This will add the specified tag to the configuration of the given module.

Delete a tag configuration

This will delete the configuration of a module for the specified tag.

Update a tag configuration

This will update the configuration of a module for the specified tag.

Get modules list

This will return a list with the names of all available modules.

Create module global configuration

This will create a new global configuration for an existing module. Any previous configuration will be overwritten. It is up to the module to specify what settings it requires for itself.

Delete module global configuration

This will delete the global configuration of the specified module.

Get global configuration by name

This will return a module’s global configuration with the specified name.

Update module global configuration

Update the global configuration of a module with the specified name.

Get stats

Get various counters of the current running policy engine instance.

Get version

Get the version of the current policy engine.