diff options
author | Jonas Gunz <himself@jonasgunz.de> | 2021-01-13 21:40:38 +0100 |
---|---|---|
committer | Jonas Gunz <himself@jonasgunz.de> | 2021-01-13 21:40:38 +0100 |
commit | 7c9a41df72a0a2610bb2ba76728c665af51e0ab8 (patch) | |
tree | 6da3b0db11df4acbdde102f68ca930ac7df4486f | |
parent | aaa5eca916b7e3c335d3be1ed41cd81e74b75664 (diff) | |
download | python-phpipam-7c9a41df72a0a2610bb2ba76728c665af51e0ab8.tar.gz |
README
-rw-r--r-- | README.md | 11 |
1 files changed, 6 insertions, 5 deletions
@@ -2,8 +2,6 @@ An incomplete phpIPAM API implementation in python. -Refer to the [API Doc](https://phpipam.net/api-documentation/) for data layout. - ``` import phpipam_api @@ -17,10 +15,13 @@ data = ipam.<controller>.<operation>(<arguments>) ``` All functions return a dictionary object or a list of dictionary objects. +Refer to the [API Doc](https://phpipam.net/api-documentation/) for data layout. If an error is encountered, an exception is raised. ## Controllers +Functions shared by all controllers: + * `get()` returns all obejcts in in controller * `byID(object_id=<object id>)` get specific obejct by ID * `create(data=<data>)` @@ -61,9 +62,9 @@ If an error is encountered, an exception is raised. ### prefix -requires +## requires - dateutil - requests +* `dateutil` +* `requests` License: MIT |