VictoriaMetrics Cloud API Documentation #

VictoriaMetrics Cloud provides programmatic access for managing cloud resources and is useful for automation with tools like Terraform, OpenTofu, Infrastructure as a Code, GitOps framework, etc.

Key Concepts #

• API Keys: Used to manage VictoriaMetrics Cloud resources via API.

Note: Access Tokens are used for reading and writing data to deployments. They are separate from API Keys and should not be confused. API Keys are specifically for managing resources via the API, while Access Tokens handle data access for deployments.

API Swagger/OpenAPI Reference: https://console.victoriametrics.cloud/api-docs #

API Key Properties: #

• Name: Human-readable, for team context.
• Lifetime: Key expiration date (no expiration is an option).
• Permissions: Read-only or Read/Write access.
• Deployment Access: Limit access to single, multiple, or all deployments. Note: selecting all deployments in the list and the “All” option are not the same thing, the “All" option will also apply to future deployments that are created.
• Key or Key Value: Programmatically generated identifier. It’s sensitive data used for Authentication. Any operation with API keys (including viewing/revealing Key Value), will be recorded in the Audit Log.

Authentication: #

• API Key Creation: Required for using the VictoriaMetrics Cloud API. You need to issue the key manually here.
• HTTP Header:
  • Header Name: X-VM-Cloud-Access
  • Header Value: <Key-Value>

General information API: #

• List Cloud Providers: API reference
• List Regions: API reference
• List Deployment Tiers: API reference

Deployments API: #

• List Deployments: API reference
• Get Deployment Details: API reference
• Create New Deployment: API reference
• Update Deployment Parameters: API reference
• Delete Deployment: API reference

Access Tokens API: #

• List Access Tokens: API reference
• Create New Access Token: API reference
• Reveal Access Token Secret: API reference
• Revoke Access Token: API reference

Alerting & Recording Rules API: #

• List Files: API reference
• View File: API reference
• Upload File: API reference
• Delete File: API reference

For detailed setup instructions, check the VictoriaMetrics Cloud - AlertManager Setup Guide.

Future API Features: #

• AlertManager: Get Config, Upsert Config.