VPSMetrics API

Read your account, providers, benchmarks, and tools over HTTPS using an API key from your account.

Open API reference Download OpenAPI JSON
Base URL
https://vpsmetrics.com/api/v1
Authentication
Pass your API key in the Authorization header as a Bearer token.
OpenAPI (JSON)
https://vpsmetrics.com/openapi.json

Getting started

  1. 1

    Create an API key.

    Sign in to VPSMetrics and create a key from API keys in your account.

  2. 2

    Enable only the access you need.

    Each endpoint expects a permission such as read:profile or tool:whois. Turn on the smallest set that matches your integration.

  3. 3

    Send the key on every request.

    Use Authorization: Bearer YOUR_API_KEY together with Accept: application/json.

  4. 4

    Read the JSON response.

    Success responses include a short status message and your payload; errors return a message and optional field-level details. See the Response envelopes examples below.

Available abilities

Enable the smallest set of permissions when you create a key.

Endpoint requirements in reference
Permission Label Description
read:profile Profile Read the authenticated account profile, Tool Credits summary, and billing overview.
read:providers Providers Read provider data and provider detail responses.
read:benchmarks Benchmarks Read benchmark lists and benchmark detail responses.
tool:whois WHOIS Lookup Run WHOIS lookups through the API.
tool:dns-lookup DNS Lookup Run DNS lookups through the API.
tool:dns-propagation-checker DNS Propagation Checker Run DNS propagation checks through the API.
tool:spf-checker SPF Checker Run SPF checks through the API.
tool:dmarc-lookup DMARC Lookup Run DMARC lookups through the API.
tool:what-is-my-ip What is My IP Look up IP information through the API.
tool:uptime-calculator Uptime Calculator Use the uptime calculator through the API.
tool:crontab-generator Crontab Generator Generate and validate cron expressions through the API.
tool:csv-to-json CSV to JSON Convert CSV payloads to JSON through the API.
tool:ping Multi-Location Ping Run multi-location ping checks through the API for single targets or batch IP targets.
tool:email-validation Email Validation Validate email addresses through the API using shared Email Validation units.
tool:email-deliverability-checker Email Deliverability Checker Check SPF, DKIM, DMARC, and MX email deliverability signals for a domain through the API.
tool:blacklist-checker Blacklist Checker Check one or more IP addresses or domains against the VPSMetrics blacklist provider set through the API.

Response envelopes

Success

{
  "message": "Billing summary retrieved successfully.",
  "data": {
    "billing": {
      "api_plan": {
        "is_active": true,
        "name": "API Pro"
      }
    }
  }
}

Paginated

{
  "message": "Provider data retrieved successfully.",
  "data": {
    "providers": []
  },
  "meta": {
    "pagination": {
      "current_page": 1,
      "last_page": 3,
      "per_page": 15,
      "total": 33,
      "from": 1,
      "to": 15
    }
  }
}

Error

{
  "message": "Your shared Email Validation units are exhausted for the current billing period.",
  "meta": {
    "code": "tool_quota_exhausted",
    "period_ends_at": "2026-06-04T00:00:00+00:00"
  }
}

Common HTTP status codes

Code Name Meaning
200 Success The request completed successfully and returned a data payload.
401 Unauthenticated The bearer token is missing, invalid, revoked, or expired.
403 Forbidden The current API key does not have the required ability, the account is suspended, or there is no active API plan.
404 Not found The requested provider or benchmark slug does not exist.
422 Validation failed One or more query string or JSON body fields did not pass validation.
429 Quota or rate limit exceeded The request was throttled, the API request quota was exhausted, or a shared expensive-tool quota was exhausted.

Endpoint overview

Grouped routes; full parameters and schemas live in the reference.

Profile

Read the authenticated account, current API key metadata, Tool Credits summary, and billing overview.

Method Path Permission
GET /api/v1/me read:profile
GET /api/v1/me/credits read:profile
GET /api/v1/me/billing read:profile

Providers

Browse VPS provider listings and retrieve provider detail payloads. Requires an active API plan.

Method Path Permission
GET /api/v1/providers read:providers
GET /api/v1/providers/{slug} read:providers

Benchmarks

Query benchmark collections and individual benchmark records. Requires an active API plan.

Method Path Permission
GET /api/v1/benchmarks read:benchmarks
GET /api/v1/benchmarks/{slug} read:benchmarks

Tools

Run selected VPSMetrics tools through the API with an API key that has the matching tool permission. Tool requests consume API request quota, and expensive tools can also consume shared tool-specific units.

Tools — 14 endpoints
Method Path Permission
POST /api/v1/tools/whois tool:whois
POST /api/v1/tools/dns-lookup tool:dns-lookup
POST /api/v1/tools/dns-propagation-checker tool:dns-propagation-checker
POST /api/v1/tools/spf-checker tool:spf-checker
POST /api/v1/tools/dmarc-lookup tool:dmarc-lookup
POST /api/v1/tools/what-is-my-ip tool:what-is-my-ip
POST /api/v1/tools/uptime-calculator tool:uptime-calculator
POST /api/v1/tools/crontab-generator tool:crontab-generator
POST /api/v1/tools/csv-to-json tool:csv-to-json
POST /api/v1/tools/ping tool:ping
POST /api/v1/tools/ping/batch tool:ping
POST /api/v1/tools/email-validation tool:email-validation
POST /api/v1/tools/email-deliverability-checker tool:email-deliverability-checker
POST /api/v1/tools/blacklist-checker tool:blacklist-checker

Request examples

General examples

cURL

curl -X GET "https://vpsmetrics.com/api/v1/providers?per_page=10"   -H "Accept: application/json"   -H "Authorization: Bearer YOUR_API_KEY"

JavaScript

const response = await fetch('https://vpsmetrics.com/api/v1/me/billing', {
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer YOUR_API_KEY',
  },
});

const payload = await response.json();
console.log(payload);

Email Deliverability Checker example

Use this endpoint to analyze SPF, DKIM, DMARC, and MX records for one domain.

cURL

curl -X POST "https://vpsmetrics.com/api/v1/tools/email-deliverability-checker" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example.com"
  }'

JavaScript

const response = await fetch('https://vpsmetrics.com/api/v1/tools/email-deliverability-checker', {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    domain: 'example.com',
  }),
});

const payload = await response.json();
console.log(payload.data.result);