List providers
curl --request GET \
--url http://localhost:8080/api/v1/providers \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/api/v1/providers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/api/v1/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/providers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"slug": "<string>",
"name": "Ookla",
"enabled": true,
"is_healthy": true,
"last_run_at": "<string>",
"last_run_status": "<string>",
"alert_on_failure": true,
"last_result": {
"id": "<string>",
"provider_slug": "<string>",
"provider_name": "Ookla",
"status": "<string>",
"download": 123,
"upload": 123,
"ping": 123,
"jitter": 123,
"packet_loss": 123,
"server_name": "<string>",
"server_location": "<string>",
"isp": "<string>",
"share_url": "<string>",
"measured_at": "<string>"
},
"last_known_good": {
"id": "<string>",
"provider_slug": "<string>",
"provider_name": "Ookla",
"status": "<string>",
"download": 123,
"upload": 123,
"ping": 123,
"jitter": 123,
"packet_loss": 123,
"server_name": "<string>",
"server_location": "<string>",
"isp": "<string>",
"share_url": "<string>",
"measured_at": "<string>"
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
},
"success": true,
"code": 200
}{
"success": false,
"code": 401,
"message": "<string>"
}{
"success": false,
"code": 404,
"message": "<string>"
}{
"success": false,
"code": 405,
"message": "<string>"
}{
"success": false,
"code": 422,
"message": "<string>",
"errors": "<string>"
}{
"success": false,
"code": 429,
"message": "<string>"
}{
"success": false,
"code": 500,
"message": "<string>"
}Providers
List providers
List all configured providers with pagination, filtering, and sorting.
GET
/
v1
/
providers
List providers
curl --request GET \
--url http://localhost:8080/api/v1/providers \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/api/v1/providers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/api/v1/providers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/providers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/providers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/providers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"slug": "<string>",
"name": "Ookla",
"enabled": true,
"is_healthy": true,
"last_run_at": "<string>",
"last_run_status": "<string>",
"alert_on_failure": true,
"last_result": {
"id": "<string>",
"provider_slug": "<string>",
"provider_name": "Ookla",
"status": "<string>",
"download": 123,
"upload": 123,
"ping": 123,
"jitter": 123,
"packet_loss": 123,
"server_name": "<string>",
"server_location": "<string>",
"isp": "<string>",
"share_url": "<string>",
"measured_at": "<string>"
},
"last_known_good": {
"id": "<string>",
"provider_slug": "<string>",
"provider_name": "Ookla",
"status": "<string>",
"download": 123,
"upload": 123,
"ping": 123,
"jitter": 123,
"packet_loss": 123,
"server_name": "<string>",
"server_location": "<string>",
"isp": "<string>",
"share_url": "<string>",
"measured_at": "<string>"
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
},
"success": true,
"code": 200
}{
"success": false,
"code": 401,
"message": "<string>"
}{
"success": false,
"code": 404,
"message": "<string>"
}{
"success": false,
"code": 405,
"message": "<string>"
}{
"success": false,
"code": 422,
"message": "<string>",
"errors": "<string>"
}{
"success": false,
"code": 429,
"message": "<string>"
}{
"success": false,
"code": 500,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Paginated set of ProviderResource
Hide child attributes
Hide child attributes
Available options:
Ookla, LibreSpeed, Netflix, Cloudflare Hide child attributes
Hide child attributes
Available options:
Ookla, LibreSpeed, Netflix, Cloudflare Hide child attributes
Hide child attributes
Available options:
Ookla, LibreSpeed, Netflix, Cloudflare Hide child attributes
Hide child attributes
Required range:
x >= 1Required range:
x >= 1Required range:
x >= 1Base path for paginator generated URLs.
Number of items shown per page.
Required range:
x >= 0Number of the last item in the slice.
Required range:
x >= 1Total number of items being paginated.
Required range:
x >= 0⌘I