github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/docs/victoriametrics-cloud/api.md
Artem Navoiev 38f7cae398
docs: add API doc for cloud (#7164) 
### Describe Your Changes

Please provide a brief description of the changes you made. Be as
specific as possible to help others understand the purpose and impact of
your modifications.

### Checklist

The following checks are **mandatory**:

- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).

Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 504da7d02b)
2024-10-02 12:41:15 +02:00

2.5 KiB
Raw Blame History

weight title menu
8 VictoriaMetrics Cloud API Documentation
docs
parent weight name
cloud 8 API

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://cloud.victoriametrics.com/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 ID: Programmatically generated identifier. It's sensitive data used for Authentication. Any operation with API keys (including viewing Key ID), will be recorded in the Audit Log.

Create API Key

Authentication:

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

Alerting & Recording Rules API:

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

Future API Features:

  • Deployments: Create, Delete, Update, List, Get.
  • Access Token: Create, Delete, List, Get/Reveal.
  • AlertManager: Get Config, Upsert Config.