Skip to main content
GET
/
platforms
/
{platformID}
SDK (@phosra/sdk)
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.get("fire_tablet");
console.log(result);
{
  "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": {}
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
platformID
string
required

Response

Platform details

​
id
string

Unique identifier for this resource.

​
name
string

Human-readable display name.

​
category
enum<string>

OCSS rule category this rule enforces (see the Rule Categories reference).

Available options:
dns,
streaming,
gaming,
device,
browser
​
tier
enum<string>

Accreditation / integration tier of the platform.

Available options:
compliant,
provisional,
pending
​
description
string

Human-readable description.

​
icon_url
string

URL of the platform or resource icon.

​
auth_type
enum<string>

How the platform is authenticated (e.g. oauth, manual).

Available options:
api_key,
oauth2,
manual
​
enabled
boolean

Whether this item is currently active.

​
enforcement_mode
enum<string>

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.

Available options:
dns,
device,
api_write,
manual_attested,
coming_soon
​
rule_support
object

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.