-
Notifications
You must be signed in to change notification settings - Fork 144
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#153 Add documentation blocks in api.py
- Loading branch information
Showing
2 changed files
with
209 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,38 +16,48 @@ TheHive4py allows the following features: | |
| === "Alerts" | ||
| - [X] [Search for alerts](reference/api#thehive4py.api.TheHiveApi.find_alerts) | ||
| - [X] [Create alert](reference/api#thehive4py.api.TheHiveApi.create_alert) | ||
| - [X] [Get alert](reference/api#thehive4py.api.TheHiveApi.get_alert) | ||
| - [X] [Update alert](reference/api#thehive4py.api.TheHiveApi.update_alert) | ||
| - [X] [Mark alert as Read](reference/api#thehive4py.api.TheHiveApi.mark_alert_as_read) | ||
| - [X] [Mark alert as Read](reference/api#thehive4py.api.TheHiveApi.mark_alert_as_unread) | ||
| - [X] [Promote alert to case](reference/api#thehive4py.api.TheHiveApi.promote_alert_to_case) | ||
| - [ ] Delete alert | ||
| - [ ] Create case from many alert | ||
| - [ ] Merge alert into an existing case | ||
| - [ ] Run responder on an alert | ||
| === "Cases" | ||
| - [X] [Search for cases](reference/api#thehive4py.api.TheHiveApi.find_cases) | ||
| - [X] [Get first case](reference/api#thehive4py.api.TheHiveApi.find_first) | ||
| - [X] [Create case](reference/api#thehive4py.api.TheHiveApi.create_case) | ||
| - [X] [Update case](reference/api#thehive4py.api.TheHiveApi.update_case) | ||
| - [X] [Delete case](reference/api#thehive4py.api.TheHiveApi.delete_case) | ||
| - [X] [Get related cases](reference/api#thehive4py.api.TheHiveApi.get_linked_case) | ||
| - [ ] Run responder on a case | ||
| === "Tasks" | ||
| - [X] [Search for tasks](reference/api#thehive4py.api.TheHiveApi.find_tasks) | ||
| - [X] [Create tasks](reference/api#thehive4py.api.TheHiveApi.create_case_task) | ||
| - [X] [Get task by id](reference/api#thehive4pi.api.TheHiveApi.get_case_task) | ||
| - [ ] Update tasks | ||
| - [ ] Delete tasks | ||
| - [X] [Create task logs](reference/api#thehive4py.api.TheHiveApi.create_task_log) | ||
| - [ ] Run responder on task | ||
| - [X] [Get log by id](reference/api#thehive4pi.api.TheHiveApi.get_task_log) | ||
| - [X] [List task logs by task id](reference/api#thehive4pi.api.TheHiveApi.get_task_logs) | ||
| - [ ] Run responder on a task | ||
| === "Observables" | ||
| - [X] [Search for observables of a case](reference/api#thehive4py.api.TheHiveApi.get_case_observables) | ||
| - [ ] Search for observables | ||
| - [X] [Create observables](reference/api#thehive4py.api.TheHiveApi.create_case_observable) | ||
| - [ ] Update observables | ||
| - [ ] [Update observables](reference/api#thehive4py.api.TheHiveApi.create_caseupdate) | ||
| - [ ] Delete observables | ||
| - [ ] Run analyzer on observable | ||
| - [ ] Run responder on observable | ||
| - [ ] [Run analyzer on observable](reference/api#thehive4py.api.TheHiveApi.run_analyzer) | ||
| - [ ] Run responder on an observable | ||
|
|
||
| === "Administration" | ||
| - [X] [Search for Case templates](reference/api#thehive4py.api.find_case_templates) | ||
| - [X] [Get Case template by name](reference/api#thehive4py.api.get_case_template) | ||
| - [X] [Create Case templates](reference/api#thehive4py.api.create_case_template) | ||
| - [X] [Create custom fields](reference/api#thehive4py.api.create_custom_field) | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| On macOS and Linux, type: | ||
|
|
@@ -59,28 +69,29 @@ sudo pip install thehive4py | |
| If you are using Python on a Windows operating system, please forgo the `sudo` command. | ||
|
|
||
| ## License | ||
| TheHive4py is an open source and free software released under the [AGPL](https://github.com/TheHive-Project/TheHive/blob/master/LICENSE) (Affero General Public License). We, TheHive Project, are committed to ensure that TheHive4py will remain a free and open source project on the long-run. | ||
|
|
||
| TheHive4py is an open source and free software released under the [AGPL](https://github.com/TheHive-Project/TheHive/blob/master/LICENSE) (Affero General Public License). We, TheHive Project, are committed to ensure that TheHive4py will remain a free and open source project on the long-run. | ||
|
|
||
| ## Updates | ||
| Information, news and updates are regularly posted on [TheHive Project Twitter account](https://twitter.com/thehive_project) and on [the blog](https://blog.thehive-project.org/). | ||
|
|
||
| Information, news and updates are regularly posted on [TheHive Project Twitter account](https://twitter.com/thehive_project) and on [the blog](https://blog.thehive-project.org/). | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome your contributions. Please feel free to fork the code, play with it, make some patches and send us pull requests using [issues](https://github.com/TheHive-Project/TheHive4py/issues). | ||
|
|
||
| We do have a [Code of conduct](code_of_conduct.md). Make sure to check it out before contributing. | ||
|
|
||
|
|
||
| ## Support | ||
|
|
||
| Please [open an issue on GitHub](https://github.com/TheHive-Project/TheHive4py/issues/new) if you'd like to report a bug or request a feature. We are also available on [Gitter](https://gitter.im/TheHive-Project/TheHive) to help you out. | ||
|
|
||
| If you need to contact the project team, send an email to <[email protected]>. | ||
|
|
||
|
|
||
| ## Community Discussions | ||
| We have set up a Google forum at <https://groups.google.com/a/thehive-project.org/d/forum/users>. To request access, you need a Google account. You may create one [using a Gmail address](https://accounts.google.com/SignUp?hl=en) or [without one](https://accounts.google.com/SignUpWithoutGmail?hl=en). | ||
|
|
||
| We have set up a Google forum at <https://groups.google.com/a/thehive-project.org/d/forum/users>. To request access, you need a Google account. You may create one [using a Gmail address](https://accounts.google.com/SignUp?hl=en) or [without one](https://accounts.google.com/SignUpWithoutGmail?hl=en). | ||
|
|
||
| ## Website | ||
| <https://thehive-project.org/> | ||
|
|
||
| [https://thehive-project.org/](https://thehive-project.org) | ||
Oops, something went wrong.