About the Virtana SO API
Note
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:
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) |
| 12/15/2025 |
|
|
Production 2 (Las Vegas) |
| 12/15/2025 |
|
|
Production 3 (Sydney) |
| 12/15/2025 |
|
|
Production 4 (Frankfurt) |
| 12/15/2025 |
|
|
Preview (Iowa) |
| 11/1/2025 |
|
|
If you are unsure which endpoint to use, please contact Virtana support.
Tip
When you generate a new Authentication keys for Virtana Service Observability API clients, 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.