Firefox Remote Settings - the live configuration service Firefox reads (blocklists, feature settings, and curated data).
This is a community listing. If you own this API, you can request ownership.
npm install omnistream-sdkimport { OmniClient } from "omnistream-sdk";
const omni = new OmniClient({ token: process.env.OMNI_KEY! });
// One key reaches every API on the marketplace.
const data = await omni.call("mozilla/server_info");One install, one key - the same client calls every API on the marketplace.
/**
* RemoteSettingsPROD - generated by OmniStream from Remote Settings PROD's OpenAPI spec.
* One typed method per endpoint. A single Omni key reaches the API.
*/
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/mozilla";
export class RemoteSettingsPRODError extends Error {
status: number;
code?: string;
constructor(status: number, code: string | undefined, message?: string) {
super(message || `RemoteSettingsPROD error ${status}`);
this.name = "RemoteSettingsPRODError";
this.status = status;
this.code = code;
}
}
export interface RemoteSettingsPRODOptions {
baseUrl?: string;
fetch?: typeof fetch;
timeoutMs?: number;
}
export class RemoteSettingsPROD {
/** @param token Your OmniStream key (one key for every API). */
constructor(private token: string, private opts: RemoteSettingsPRODOptions = {}) {
if (!token) throw new Error("RemoteSettingsPROD: token is required");
}
rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;
private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
const f = this.opts.fetch ?? globalThis.fetch;
const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
const headers: Record<string, string> = { "x-omni-key": this.token };
if (body !== undefined) headers["content-type"] = "application/json";
const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
this.rateLimit = {
remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
};
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new RemoteSettingsPRODError(res.status, data?.error?.code, data?.error?.message);
return data.data ?? data;
}
serverInfo(): Promise<any> {
return this._request("GET", "/", {});
}
getOpenapiSpec(): Promise<any> {
return this._request("GET", "/__api__", {});
}
heartbeat(): Promise<any> {
return this._request("GET", "/__heartbeat__", {});
}
lbheartbeat(): Promise<any> {
return this._request("GET", "/__lbheartbeat__", {});
}
version(): Promise<any> {
return this._request("GET", "/__version__", {});
}
batch(body: unknown): Promise<any> {
return this._request("POST", "/batch", { body });
}
getBuckets(params: { "_limit"?: number; "_sort"?: unknown[]; "_token"?: string; "_since"?: number; "_to"?: number; "_before"?: number; "id"?: string; "last_modified"?: number; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets", { params });
}
getChangess(params: { "_limit"?: number; "_sort"?: unknown[]; "_token"?: string; "_since"?: number; "_to"?: number; "_before"?: number; "id"?: string; "last_modified"?: number; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/monitor/collections/changes/records", { params });
}
getCollectionChangeset(params: { "bid": string; "cid": string; "_expected": string; "_since"?: string; "_limit"?: number; "bucket"?: string; "collection"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bid}/collections/{cid}/changeset", { params });
}
getCollections(params: { "bucket_id": string; "_limit"?: number; "_sort"?: unknown[]; "_token"?: string; "_since"?: number; "_to"?: number; "_before"?: number; "id"?: string; "last_modified"?: number; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/collections", { params });
}
getRecords(params: { "bucket_id": string; "collection_id": string; "_limit"?: number; "_sort"?: unknown[]; "_token"?: string; "_since"?: number; "_to"?: number; "_before"?: number; "id"?: string; "last_modified"?: number; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/collections/{collection_id}/records", { params });
}
getRecord(params: { "bucket_id": string; "collection_id": string; "id": string; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/collections/{collection_id}/records/{id}", { params });
}
createAttachment(params: { "bucket_id": string; "collection_id": string; "id": string }): Promise<any> {
return this._request("POST", "/buckets/{bucket_id}/collections/{collection_id}/records/{id}/attachment", { params });
}
deleteAttachment(params: { "bucket_id": string; "collection_id": string; "id": string }): Promise<any> {
return this._request("DELETE", "/buckets/{bucket_id}/collections/{collection_id}/records/{id}/attachment", { params });
}
getCollection(params: { "bucket_id": string; "id": string; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/collections/{id}", { params });
}
getGroups(params: { "bucket_id": string; "_limit"?: number; "_sort"?: unknown[]; "_token"?: string; "_since"?: number; "_to"?: number; "_before"?: number; "id"?: string; "last_modified"?: number; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/groups", { params });
}
getGroup(params: { "bucket_id": string; "id": string; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{bucket_id}/groups/{id}", { params });
}
getBucket(params: { "id": string; "_fields"?: unknown[]; "If-Match"?: string; "If-None-Match"?: string }): Promise<any> {
return this._request("GET", "/buckets/{id}", { params });
}
contribute(): Promise<any> {
return this._request("GET", "/contribute.json", {});
}
}
export default RemoteSettingsPROD;
No reviews yet. Be the first to rate this API.
No. Remote Settings PROD is included with your Omni key, so a single OmniStream key is enough to start calling it. There is no separate signup with the provider and no second key to manage.
Firefox Remote Settings - the live configuration service Firefox reads (blocklists, feature settings, and curated data). It exposes 19 endpoints over GET, POST, DELETE, including GET /, GET /__api__, GET /__heartbeat__.
Install the OmniStream SDK for your language and call Remote Settings PROD through it. The client is generated from this API's OpenAPI spec, so parameters and responses are fully typed, and the same client also calls every other API in the marketplace.
You can start on the free plan. OmniStream charges for the unified SDK, key storage and proxy rather than for Remote Settings PROD itself.
QuickChart: An API to generate charts and QR codes using QuickChart services.