Registration Keys¶
Registration keys are used to register new Surfmeter clients with your server. Each key controls how many clients can register with it and what capabilities those clients will have.
Key list¶
The Registration Keys page shows all keys with their status. You can toggle between showing all keys or hiding exhausted ones.
Key statuses¶
- Active – The key can still be used to register clients.
- Expired – The key's validity period has passed.
- Exhausted – The maximum number of registrations has been reached.
Creating a key¶
Administrators can create new registration keys. When creating a key, you configure its properties such as a comment, validity period, and how many clients may register with it.
Tip
You can set a key as testing, which can be used for evaluation and internal purposes. These will not be billed. Of course, please don't set all keys as testing if you are actually using Surfmeter in production – this would make it difficult for us to provide accurate billing and support.
Key details¶
Click on a key to view its detail page. This shows:
- The registration key value itself (copyable).
- A comment describing the key's purpose.
- Validity period (from/until).
- Number of remaining registrations (or unlimited).
- The assigned capability, which determines what measurements the registered clients are allowed to perform.
- Optional usage limit in days.
- Whether the key is marked for testing.
- A list of clients that were registered using this key.
Editing a key¶
On the detail page, you can edit the key's comment, validity dates, number of remaining registrations, assigned capability, usage limit, and testing flag.
Deleting a key¶
You can delete a key from the list page or its detail page. A confirmation dialog prevents accidental deletion. Deleting a key does not affect clients that were already registered with it.