Page Comparison

The API module contains all functionality necessary to provide modern REST-based API interfaces.

Configuration Options

...

Option

...

Possible Values

...

Description

...

api.logging

...

true / false

...

If set to true the requests are logged to api_logs table and can be searched within the UI.

...

api.forceApplication

...

true / false

<api>
  <whitelist>{{ string, string }}</whitelist>
  <logging>{{ bool }}</logging>
  <loggingBlacklist>{{ string, string }}</loggingBlacklist>
  <whitelistHeader>{{ string }}</whitelistHeader>
  <forceApplication>{{ bool}}</forceApplication>
</api>

• whitelist: Enthält eine Auflistung von IPv4- und IPv6-Adressen, welche Zugriff auf die API haben.

  • default: [] Alle haben Zugriff

• logging: Logging der API Zugriff in der Tabelle api_logs

  • default: false

• loggingBlacklist: Liste der Aufrufe, die nicht geloggt werden soll z.B. keepAlive

  • default: []

• whitelistHeader: Aus welchem Feld die Adresse gelesen wird. https://www.php.net/manual/en/reserved.variables.server.php

  • default: “REMOTE_ADDR“

• forceApplication : If set to true requests without a valid x-application header will fail.

...

api.whitelist

...

...

A list of IP addresses that is used by the IPWhitelistGuard to check for valid requests

...

api.whitelistHeader

...

string

...

• • default: false