Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
snaow committed Feb 24, 2016
1 parent 2b021ba commit 4fa5f00
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,41 @@
# OSSEC Wazuh RESTful API

OSSEC Wazuh RESTful API is a service to control OSSEC Wazuh manager using REST requests. It allows you to execute OSSEC commands for agents remote management (add, restart, info, key export) or to extract rootcheck and syscheck information (restart, check last scan...). The goal is to provide an interface to manage your OSSEC deployment remotely (e.g. through a web browser), or to integrate OSSEC with external systems.
OSSEC Wazuh RESTful API provides a new mechanism to manage OSSEC Wazuh. The goal is to manage your OSSEC deployment remotely (e.g. through a web browser), or to control OSSEC with external systems.

Perform everyday actions like adding an agent, restart OSSEC, or check the configuration are now simplest using Wazuh RESTful API.

OSSEC Wazuh API RESTful capabilities:

- Agents management
- Manager control & overview
- Rootcheck control
- Syscheck control
- Statistical Information
- HTTPS and User authentication
- Error Handling


## Documentation

[Full documentation and installation guide](http://documentation.wazuh.com/en/latest/ossec_api.html).
#### How to install

[Installation guide](http://documentation.wazuh.com/en/latest/ossec_api.html#installation)

#### Request reference

[Full request reference](http://documentation.wazuh.com/en/latest/ossec_api.html#installation)

#### Full documentation

[Full documentation](http://documentation.wazuh.com/en/latest/ossec_api.html)

## Contribute

If you want to contribute to our project please don't hesitate to send a pull request. You can also join our users [mailing list](https://groups.google.com/d/forum/wazuh), by sending an email to [[email protected]](mailto:[email protected]), to ask questions and participate in discussions.


## References

* [Wazuh website](http://wazuh.com)
* [Wazuh repositories](http://github.com/wazuh)
* [Wazuh documentation](http://documentation.wazuh.com)

0 comments on commit 4fa5f00

Please sign in to comment.