Zenoss API

Info

Looking for the Zenoss API for Collection Zone and Resource Manager?

The Zenoss API enables customized integrations with Zenoss Cloud services through a RESTful interface. The following services are supported:

• Action service
• Credentials service
• Data receiver service
• Dictionary service
  • Entity fields
  • Event fields
  • Metrics
• Event management 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-ENDPOINT and 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.

Stack	Endpoint
EMEA	api.zenoss.eu
Preview	api-zing-preview.zenoss.io
Production 1	api.zenoss.io
Production 2	api2.zenoss.io
Production 2 (IPv6)	api2-ipv6.zenoss.io
Production 3	api3.zenoss.io

If you are unsure which endpoint to use, please contact your Zenoss representative.

Tip

When you generate a new Zenoss API key, the dialog box displays your organization's endpoint.

gRPC methods for data receiver resources

For high-performance agents or integrations, the data receiver service also supports gRPC/Protobuf.

• Zenoss publishes protobufs for the data receiver service in the zenoss-protobufs repository.

• The open-source Kubernetes agent is an example of using gRPC in a Go program. The agent also uses the Zenoss Go SDK.