import { PhosraClient } from "@phosra/sdk";
const phosra = new PhosraClient({
baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1",
accessToken: process.env.PHOSRA_API_KEY,
});
const result = await phosra.platforms.byCapability("web_filtering");
console.log(result);curl -sS "https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability?capability=web_filtering"
import requests
BASE = "https://phosra-api-sandbox-production.up.railway.app/api/v1"
res = requests.get(
f"{BASE}/platforms/by-capability?capability=web_filtering",
)
print(res.status_code, res.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
base := "https://phosra-api-sandbox-production.up.railway.app/api/v1"
req, _ := http.NewRequest("GET", base+"/platforms/by-capability?capability=web_filtering", nil)
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(out))
}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability",
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;
}HttpResponse<String> response = Unirest.get("https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "nextdns",
"name": "NextDNS",
"category": "dns",
"tier": "compliant",
"description": "DNS-level content filtering and SafeSearch enforcement for family networks.",
"icon_url": "https://cdn.phosra.com/platforms/nextdns.svg",
"auth_type": "api_key",
"enabled": true,
"enforcement_mode": "dns",
"rule_support": {}
}
]{
"error": "Unauthorized",
"message": "missing or invalid Authorization header",
"code": 401
}{
"error": "Too Many Requests",
"message": "rate limit exceeded",
"code": 429
}{
"error": "Internal Server Error",
"message": "internal error",
"code": 500
}{
"error": "Bad Gateway",
"message": "downstream provider error",
"code": 502
}{
"error": "Service Unavailable",
"message": "downstream provider unavailable",
"code": 503
}Filter by capability
Filter platforms by capability
import { PhosraClient } from "@phosra/sdk";
const phosra = new PhosraClient({
baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1",
accessToken: process.env.PHOSRA_API_KEY,
});
const result = await phosra.platforms.byCapability("web_filtering");
console.log(result);curl -sS "https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability?capability=web_filtering"
import requests
BASE = "https://phosra-api-sandbox-production.up.railway.app/api/v1"
res = requests.get(
f"{BASE}/platforms/by-capability?capability=web_filtering",
)
print(res.status_code, res.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
base := "https://phosra-api-sandbox-production.up.railway.app/api/v1"
req, _ := http.NewRequest("GET", base+"/platforms/by-capability?capability=web_filtering", nil)
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(out))
}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability",
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;
}HttpResponse<String> response = Unirest.get("https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://phosra-api-sandbox-production.up.railway.app/api/v1/platforms/by-capability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "nextdns",
"name": "NextDNS",
"category": "dns",
"tier": "compliant",
"description": "DNS-level content filtering and SafeSearch enforcement for family networks.",
"icon_url": "https://cdn.phosra.com/platforms/nextdns.svg",
"auth_type": "api_key",
"enabled": true,
"enforcement_mode": "dns",
"rule_support": {}
}
]{
"error": "Unauthorized",
"message": "missing or invalid Authorization header",
"code": 401
}{
"error": "Too Many Requests",
"message": "rate limit exceeded",
"code": 429
}{
"error": "Internal Server Error",
"message": "internal error",
"code": 500
}{
"error": "Bad Gateway",
"message": "downstream provider error",
"code": 502
}{
"error": "Service Unavailable",
"message": "downstream provider unavailable",
"code": 503
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Response
Filtered platform list
Unique identifier for this resource.
Human-readable display name.
OCSS rule category this rule enforces (see the Rule Categories reference).
dns, streaming, gaming, device, browser Accreditation / integration tier of the platform.
compliant, provisional, pending Human-readable description.
URL of the platform or resource icon.
How the platform is authenticated (e.g. oauth, manual).
api_key, oauth2, manual Whether this item is currently active.
How Phosra enforces rules on this platform. dns = live DNS-provider API write (NextDNS/CleanBrowsing/Control D); device = on-device enforcement, requires Phosra app installed; api_write = live third-party write API; manual_attested = no programmatic API — Phosra generates setup steps and records a signed parent attestation. Never render "Enforced" for this value; coming_soon = adapter not yet built.
dns, device, api_write, manual_attested, coming_soon Per-category enforcement support across all 123 OCSS rule categories. dns = DNS provider can filter this category; device = on-device enforcement handles it; guided = manual_attested platform, parent applies with Phosra guidance; unsupported = not addressable on this platform.
Show child attributes
Show child attributes