Skip to content

Commit ddc897b

Browse files
committed
Fix #38 - Update documentations
As phpIPAM does not support `User token` via `http` by default we need to adapt our documentation to reflect these fact.
1 parent 9added6 commit ddc897b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

phpypam/core/api.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ def __init__(self, url, app_id, username=None, password=None, token=None, encryp
2727
2828
The costructor collects all data to connect to phpIPAM API. If all data is there it makes the connection to the given server.
2929
30-
:param url: The URL to a phpIPAM instance. As phpIPAM expects `https` we also only supports secure connections.
30+
:param url: The URL to a phpIPAM instance. It includes the protocol (`https` or `http`).
31+
As phpIPAM does not support `http` and `User token` by default you have to configure phpIPAM to allow unsecure connections.
32+
But be aware on security risk in conjunction with this setting.
3133
:type url: str
3234
:param app_id: The app_id which is used for the API operations.
3335
For modifying operations it needs read/write access.

0 commit comments

Comments
 (0)