The Zenoss API enables customized integrations with Zenoss Cloud services through a RESTful interface. The following services are supported:
- Action service
- Data receiver service
- Event management service
- Metric dictionary service
- Event fields dictionary service
- User management service
All Zenoss API endpoints require HTTPS, expect JSON in the request body when a body is required, and return a JSON response.
You must have an authentication key
to send requests to a Zenoss API endpoint. The key is sent in the
zenoss-api-key header of each request. Note that the user management
service requires a different type of key than all other services.
All API examples use curl
to send a JSON request from a Bash shell to an endpoint. Also,
all examples use
YOUR-API-KEY as placeholders
for endpoints and authentication keys, respectively.
Zenoss API endpoints
Zenoss Cloud supports the Zenoss API endpoints in the following table.
If you are unsure which endpoint to use, please contact your Zenoss representative.