Update provider

curl --request PATCH \
  --url http://localhost:8080/api/v1/providers/{provider} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_enabled": true,
  "alert_on_failure": true,
  "server_url": "<string>",
  "server_id": "<string>"
}
'

import requests

url = "http://localhost:8080/api/v1/providers/{provider}"

payload = {
    "is_enabled": True,
    "alert_on_failure": True,
    "server_url": "<string>",
    "server_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_enabled: true,
    alert_on_failure: true,
    server_url: '<string>',
    server_id: '<string>'
  })
};

fetch('http://localhost:8080/api/v1/providers/{provider}', 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/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_enabled' => true,
    'alert_on_failure' => true,
    'server_url' => '<string>',
    'server_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/providers/{provider}"

	payload := strings.NewReader("{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("http://localhost:8080/api/v1/providers/{provider}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/providers/{provider}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}"

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>"
    }
  },
  "success": true,
  "code": 200,
  "message": "Provider updated successfully."
}

{
  "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>"
}

PATCH

providers

{provider}

Update provider

curl --request PATCH \
  --url http://localhost:8080/api/v1/providers/{provider} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_enabled": true,
  "alert_on_failure": true,
  "server_url": "<string>",
  "server_id": "<string>"
}
'

import requests

url = "http://localhost:8080/api/v1/providers/{provider}"

payload = {
    "is_enabled": True,
    "alert_on_failure": True,
    "server_url": "<string>",
    "server_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_enabled: true,
    alert_on_failure: true,
    server_url: '<string>',
    server_id: '<string>'
  })
};

fetch('http://localhost:8080/api/v1/providers/{provider}', 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/{provider}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_enabled' => true,
    'alert_on_failure' => true,
    'server_url' => '<string>',
    'server_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/providers/{provider}"

	payload := strings.NewReader("{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("http://localhost:8080/api/v1/providers/{provider}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/providers/{provider}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_enabled\": true,\n  \"alert_on_failure\": true,\n  \"server_url\": \"<string>\",\n  \"server_id\": \"<string>\"\n}"

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>"
    }
  },
  "success": true,
  "code": 200,
  "message": "Provider updated successfully."
}

{
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider

enum<string>

required

The provider slug

Available options:

ookla,

librespeed,

netflix,

cloudflare

Body

application/json

is_enabled

boolean

required

alert_on_failure

boolean

required

server_url

string<uri> | null

Maximum string length: 500

server_id

string | null

Maximum string length: 20

Pattern: ^\d+$

Response

ProviderResource

data

ProviderResource · object

required

Hide child attributes

data.id

integer

required

data.slug

string

required

data.name

enum<string>

required

Available options:

Ookla,

LibreSpeed,

Netflix,

Cloudflare

data.enabled

boolean

required

data.is_healthy

boolean

required

data.last_run_at

string | null

required

data.last_run_status

string | null

required

data.alert_on_failure

boolean

required

data.last_result

SpeedResultResource · object | null

required

Hide child attributes

data.last_result.id

string

required

data.last_result.provider_slug

string

required

data.last_result.provider_name

enum<string>

required

Available options:

Ookla,

LibreSpeed,

Netflix,

Cloudflare

data.last_result.status

string

required

data.last_result.download

number | null

required

data.last_result.upload

number | null

required

data.last_result.ping

number | null

required

data.last_result.jitter

number | null

required

data.last_result.packet_loss

number | null

required

data.last_result.server_name

string | null

required

data.last_result.server_location

string | null

required

data.last_result.isp

string | null

required

data.last_result.measured_at

string

required

data.last_known_good

SpeedResultResource · object | null

required

Hide child attributes

data.last_known_good.id

string

required

data.last_known_good.provider_slug

string

required

data.last_known_good.provider_name

enum<string>

required

Available options:

Ookla,

LibreSpeed,

Netflix,

Cloudflare

data.last_known_good.status

string

required

data.last_known_good.download

number | null

required

data.last_known_good.upload

number | null

required

data.last_known_good.ping

number | null

required

data.last_known_good.jitter

number | null

required

data.last_known_good.packet_loss

number | null

required

data.last_known_good.server_name

string | null

required

data.last_known_good.server_location

string | null

required

data.last_known_good.isp

string | null

required

data.last_known_good.measured_at

string

required

success

boolean

required

code

integer

required

message

string

required

Allowed value: "Provider updated successfully."

Getting Started

Configuration

Integrations

API Reference

More

Update provider

Authorizations

Path Parameters

Body

Response