Real-Time Metrics APIs

The Real-Time Metrics component provides Prometheus-compatible APIs for querying real time metrics collected from VMware vCenter environments. These APIs enable you to execute PromQL queries, retrieve metric metadata, and manage vCenter metrics configuration.

Authentication

All API requests require a valid JWT Bearer token in the Authorization header. Access is restricted to resources that the authenticated user is authorized to view or modify.

Obtaining a Token

1. Acquire an OpsToken by calling:

   POST https://<vcf-operations-fqdn>/suite-api/api/auth/token/acquire
   Content-Type: application/json
   
   {
     "username": "<username>",
     "password": "<password>"
   }
   

   This returns an OpsToken in the response.

2. Get the Real-Time metrics Service Key(service-key) by calling the integrations API (find the key where type = VCF_VODAP):

   GET https://<vcf-operations-fqdn>/suite-api/api/integrations/services
   Authorization: OpsToken <ops-token>
   

3. Exchange the Service Key for a JWT Token by calling the VCF Operations API:

   POST https://<vcf-operations-fqdn>/suite-api/api/auth/token/exchange
   Content-Type: application/json
   Authorization: OpsToken <ops-token>
   
   {
     "serviceKeys": ["<service-key>"]
   }
   

Using the Token

Include the JWT token in the Authorization header:

Authorization: Bearer <jwt-token>