๐Ÿ‡
Speedtest Tracker
  • Introduction
  • Features
  • Changelog
  • ๐Ÿš€Getting Started
    • Installation
      • Using Docker Compose
      • Using Docker
      • Using Kubernetes
      • Using QNAP
      • Using Synology
      • Using Unraid
    • Environment Variables
    • Database Drivers
  • ๐Ÿ†˜Help
    • Error Messages
    • Frequently Asked Questions
  • ๐Ÿ”‘Security
    • Authentication
    • Authorization
    • Encryption
  • โš™๏ธSettings
    • Data Integrations
      • InfluxDB v2
    • Notifications
      • Database
      • Mail
      • Webhook
  • ๐Ÿ‘€Other
    • Speedtest Process
    • Proxies
      • Cloudflare Tunnel (Zero Trust)
      • Traefik
      • Tailscale
    • Caching
    • Commands
    • Data Dictionary
    • Embed Dashboard
    • Health Check
    • Community Projects
  • ๐Ÿ–ฅ๏ธAPI
    • Authorization
    • Responses
      • Results
      • Speedtests
      • Servers
      • Stats
      • Models
  • ๐ŸคนContributing
    • Development Environment
  • ๐Ÿ”—More
    • Source Code
    • Releases
    • Update the Docs
    • About Me
    • Donate
Powered by GitBook
On this page
  1. API
  2. Responses

Speedtests

PreviousResultsNextServers

Operations to run speedtests. Requires an API token with scope speedtests:run.

๐Ÿ–ฅ๏ธ

Run a new Ookla speedtest

post
Query parameters
server_idintegerOptional

Optional Ookla speedtest server ID

Responses
201
Created
application/json
401
Unauthenticated
application/json
403
Forbidden
application/json
422
Validation error
application/json
post
POST /api/v1/speedtests/run HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "id": 1,
    "service": "text",
    "ping": 1,
    "download": 1,
    "upload": 1,
    "benchmarks": {},
    "healthy": true,
    "status": "text",
    "scheduled": true,
    "comments": "text",
    "data": {
      "server": {
        "id": 1
      }
    },
    "created_at": "2025-06-14T09:14:38.238Z",
    "updated_at": "2025-06-14T09:14:38.238Z"
  },
  "message": "text"
}