VerOps Public API
Getting started with the VerOps Public API
The VerOps Public API at api.verops.io: what it is, the /v1 base URL and versioning, creating an API-scoped key, the X-Api-Key header, your first curl call, rate limits, the JSON error model, timestamp formats, retries and idempotency, and the synchronous no-webhooks model.
Authentication and errors
Authenticate with an API-scoped key via X-Api-Key or Bearer, understand the two scopes (API versus Ingest), tell 401 from 403, read the full error code table with troubleshooting, and handle 429 rate limiting with a Retry-After backoff example.
Send custom data: metrics and events
Push your own metrics and events into VerOps with POST /v1/custom/metrics and POST /v1/custom/events. Full body parameter tables with validation, request and response examples, the 202 success and error statuses, the 1 to 1000 batch limit, and best practices for batching, timestamps, and label cardinality.
Query custom data: metrics and events
Read your custom data back with POST /v1/custom/metrics/query and POST /v1/custom/events/query. Covers raw versus time-bucketed metric queries, the step and aggregation rules, the substring event filter, time-based paging, examples, and every response and error field.
Read platform data: metrics, logs, alerts, inventory
Read the data VerOps already holds for your organization: metric names and values, logs, alerts, and software inventory. Each endpoint documented with purpose, parameter tables and validation, request and response examples, and notes on filtering, paging, and sorting.
Code examples and SDKs
The same core operations (send a metric, query it back, read alerts) shown in cURL, Python (requests), and JavaScript (fetch), plus a retry helper. There is no official SDK yet, but the OpenAPI specs at /v1/openapi.json and /openapi.json generate one with openapi-generator.