¶ API keys
¶ Overview
In this section we can configure, add and edit API keys used by the system.
This section displays a table of all API keys used by add-ons, information (such as the name of the addon, api key and the partner it is associated with):
¶ Add an API key
To create a new API key, go to Administration → Splynx → API keys and click Add in the top-right corner. The Create API key dialog opens:
Fill in the fields and click Add to save the key:
- Title — a label that identifies the key in the list (for example, the add-on name).
- Key — autogenerated public identifier used in API requests. Use the regenerate icon on the right to issue a new value.
- Secret — autogenerated secret used to sign API requests. Use the regenerate icon on the right to issue a new value. Copy and store it securely. Splynx will not show it again after the dialog is closed.
- Enable logging — when on, every API request made with this key is logged. Useful for troubleshooting add-on integrations.
- Unsecure access — when on, the key can authenticate using HTTP Basic authorization in addition to the standard signed request. Leave off unless an integration explicitly requires it.
- Partner — restricts the key to a single partner, or
Anyto allow all partners. - Allowed IPv4 — textarea listing IPv4 addresses and CIDR ranges (for example,
192.168.1.0/24) that can use the key. One entry per line.127.0.0.1is in the list by default. - Allowed IPv6 — textarea listing IPv6 addresses and CIDR ranges (for example,
2001:db8::/32) that can use the key. One entry per line.::1is in the list by default.
If both IP fields are left empty, the key is reachable from any address. If at least one is filled, the client IP must match an entry in the corresponding list — IPv4 clients are checked against Allowed IPv4 and IPv6 clients against Allowed IPv6. The default loopback entries (127.0.0.1 and ::1) stay allowed in either case, so local calls always work.
¶ Actions
Please be very careful when making any changes to your API keys as it may cause your addon's to malfunction or stop working entirely.
In the Actions column you can Edit, change permissions for the API key/add-on or delete the API key:
With the Edit icon 
you can change the configurations of the API key in the fields that are available. If the field is greyed out, this means it cannot be edited:
With the use of the Permissions icon 
you can modify the permissions of the API key to limit or grant access to each of the modules:
With the use of the trash icon 
you can delete API keys.