Virtana Service Observability API

Info

Looking for the Virtana Service Observability API for Collection Zone and Resource Manager?

The Virtana Service Observability API enables customized integrations with Virtana Service Observability 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
• Model management service

All Virtana Service Observability 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 Virtana Service Observability API endpoint. The key is sent in the zenoss-api-key header of each request.

Note

The user management service and the model management service require a different type of key than the 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.

Virtana Service Observability API endpoints

Virtana Service Observability supports the API endpoints in the following table.

Stack	Zenoss Domain Endpoint	Zenoss Domain Endpoint End of Life Date	Virtana Domain Endpoint	Virtana Domain IPv6 Endpoint
Production 1 (Iowa)	api.zenoss.io	12/15/2025	api.virtana.ai	api-zing-preview-ipv6.virtana.ai
Production 2 (Las Vegas)	api2.zenoss.io	12/15/2025	api2.virtana.ai	api-zcloud-prod2-ipv6.virtana.ai
Production 3 (Sydney)	api3.zenoss.io	12/15/2025	api3.virtana.ai	api-zcloud-prod3-ipv6.virtana.ai
Production 4 (Frankfurt)	api.zenoss.eu	12/15/2025	api4.virtana.ai	api-zcloud-emea-ipv6.virtana.ai
Preview (Iowa)	api-zing-preview.zenoss.io	11/1/2025	api-zing-preview.virtana.ai	api-zing-preview-ipv6.virtana.ai

If you are unsure which endpoint to use, please contact Virtana support.

Tip

When you generate a new Virtana Service Observability 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.

• Virtana 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.