Diese Seite enthält alle API Endpunkte von Portmaster.
Diese Seite ist noch nicht fertiggestellt und könnte nicht ganz akkurat sein. Wenn du plannst etwas zu entwickeln das mit dem Portmaster interagiert, würden wir gerne mit dir darüber reden!
Manche Endpunkte erfordern Authentifizierung, was durch API SChlüsseln abgewickelt wird. Du kannst einen API Schlüssel in einem Basic oder Bearer HTTP Authorization Header benutzen.
Für Entwicklung, möchtest du vielleicht auch Development Mode aktivieren, was Authentifikation deaktiviert und dir den vollen Zugriff gewährt. Cross-origin Anfragen sind nicht erlaubt.
| Badge | Bedeutung |
|---|---|
| User | Endpunkt benötigt Nutzer Privilegien. |
| Admin | Endpunkt benötigt Admin Privilegien. |
| Internal | Endpunkt kann nur von Portmaster verwendet werden. |
Admin
[WEBSOCKET] /api/database/v1
Die Websocket Schnittstelle ist noch nicht in einem verarbeitbaren Format. Bitte schau in die Portmaster Console App für mehr Information und Testen:
http://127.0.0.1:817/ui/modules/console/ (Benötigt Development Mode )
Frage einen Authetificaations Token mit einem Set von Erlaubnisen an. Der Nutzer wir aufgefordert entweder zu authorizieren oder abzulenen. Wird für externe oder Third-Party Werkzeug Integration.
GET /api/v1/app/auth
gibt application/json Daten wieder.
app-name
read
write
ttl
User
GET /api/v1/app/profile
gibt application/json Daten wieder.
GET /api/v1/auth/basic
gibt text/plain Daten wieder
Gibt eine HTTP Basic Authentifizierung Anfrage wieder, wenn nicht auhentifiziert.
GET /api/v1/auth/bearer
gibt text/plain Daten wieder
Gibt eine HTTP Bearer Authentifizierung Anfrage wieder, wenn nicht auhentifiziert.
GET /api/v1/auth/permissions
gibt application/json Daten zurück
Gibt die derzeitgen Genehmigungen zu der Anfrage wieder.
GET /api/v1/auth/reset
gibt text/plain Daten wieder
Setzt den Authentifizierten Status intern und im Browser zurück.
Admin
GET /api/v1/broadcasts/matching-data
gibt application/json Daten wieder
Gibt die Daten die von Broadcast Benachrichtigungen passend zur instanz wieder.
Admin
POST /api/v1/broadcasts/reset-state
gibt text/plain Daten wieder
Löscht das Cache von Broadcast Benachrichtigungen was sie neu erscheinen lässt.
Admin
POST /api/v1/broadcasts/simulate
gibt text/plain Daten wieder
Testet Broadcast Benachrichtigungen indem valide Quellendateien in dem Körper.
state
trueUser
GET /api/v1/compat/self-check
gibt text/plain Daten wieder
Lässt ein paar Integrations Selbsttest laufen um zu sehen ob die System Integration funktioniert.
GET /api/v1/config/options
gibt application/json Datan wieder
Gibt eine Liste von alle registrierten konfigurations Optionen und deren Metadaten wieder. Das inkludiert die derzeit aktiven oder Standardeinstellungen.
Admin
POST /api/v1/core/restart
gibt text/plain Datan wieder
Startet den Portmaster Core Service neu.
Internal
POST /api/v1/core/shutdown
gibt text/plain Daten wieder
Fahre Portmaster Core Service und alle UI Komponenten herunter.
GET /api/v1/debug/allocs
gibt text/plain Datan wieder
Sammlt das Speicherzuordnungsprofil und gibt es wieder
Du kannst diese Daten leicht in deinem Browser mit folgenden Kommand anschauen (mit Go installiert):
`go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/allocs`
GET /api/v1/debug/core
gibt text/plain Daten wieder
Gibt Netzerk Debug Information wieder, ähnlich zu Debug/Info, aber mit den System Status Daten.
style
githubGET /api/v1/debug/cpu
gibt text/plain Daten wieder
Sammle und Erhalte das CPU Profil. Diese Daten müssen über einige Zeit gesammelt werden, was über den "duration" Parameter angegeben wird.
Du kannst diese Daten leicht in deinem Browser mit folgenden Kommand anschauen (mit Go installiert): go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/allocs
duration
10sGET /api/v1/debug/heap
gibt text/plain Daten wieder.
Sammle und erhalte das heap Speicher Profil
Du kannst diese Daten leicht in deinem Browser mit folgenden Kommand anschauen (mit Go installiert):
`go tool pprof -http :8888 http://127.0.0.1:817/api/v1/debug/allocs`
GET /api/v1/debug/info
gibt text/plain Daten wieder
Gibt Debug Information wieder, inkludiert die Version und Plattform Info, Fehler, Protokolle und den aktuellen goroutine Stapel.
style
githubGET /api/v1/debug/network
gibt text/plain Daten weider
Gibt Netzwerk Debug Information wieder, ähnlich zu debug/core, aber mit Verbindungs Daten.
style
githubprofile
<Source>/<ID>where
<query>User
GET /api/v1/debug/network/state
gibt application/json Daten wieder
Gibt die derzeitige Netzwerkstatustabellen von dem Betriebssystem wieder.
GET /api/v1/debug/stack
gibt text/plain Daten wieder
Gibt den aktuellen Goroutine Stapel wieder.
GET /api/v1/debug/stack/print
gibt text/plain Daten wieder
Druckt den aktuellen Goroutine Stapel to stdout aus.
User
GET /api/v1/dns/cache/{query:[a-z0-9\.-]{0,512}\.[A-Z]{1,32}}
gibt application/json Daten wieder
Gibt die Zwischengespeicherten DNS Aufzeichnungen von dem Internen Cache wieder.
query (in path)
fqdn and query typeUser
POST /api/v1/dns/clear
gibt text/plain Daten wieder
Löscht alle gespeicherten DNS Aufzeichnungen von der Datenbank.
GET /api/v1/dns/resolvers
gibt application/json Daten wieder
Listet die derzeitigen konfigurierten DNS Resolver und deren Status auf.
GET /api/v1/endpoints
gibt application/json Daten wieder
Gibt eine Liste von allen registrierten Endpunkten und deren Metadaten wieder.
User
GET /api/v1/modules/status
gibt application/json Daten wieder
Gibt Statusinformationen aller Module wieder.
Internal
POST /api/v1/modules/{moduleName:.+}/trigger/{eventName:.+}
gibt text/plain Daten wieder
Löst ein Ereignis auf einem internel Modul aus.
User
GET /api/v1/netquery/charts/connection-active
POST /api/v1/netquery/charts/connection-active
returns application/json data
Frage die sqlite Verbindungen im Speicher ab und erhalte eine Tabelle von aktiven Vebrindungen
User
GET /api/v1/netquery/query
POST /api/v1/netquery/query
gibt application/json Daten wieder
Frage die Speicher sqlite Verbindungs Datenbank ab.
GET /api/v1/network/gateways
gibt application/json Daten wieder
Gibt die derzeitigen aktiven Standard Gateways des Netzwerks wieder.
User
GET /api/v1/network/location
gibt application/json Daten wieder
Gibt eine ungefähren Standort wieder wo sich das Gerät im Internet liegt.
User
GET /api/v1/network/location/traceroute
gibt application/json Daten wieder
Gibt eine ungefähren Standort wieder wo sich das Gerät im Internet liegt, mithilfe der tracerout Technik.
User
GET /api/v1/network/nameservers
gibt application/json Daten wieder
Gibt den aktuell konfigurierten Namenserver auf dem Betriebssystem wieder
GET /api/v1/ping
gibt text/plain Daten wieder
Pong.
Admin
POST /api/v1/spn/account/login
gibt text/plain Daten wieder.
Logge dich in deinem SPN Account.
Admin
DELETE /api/v1/spn/account/logout
gibt text/plain Daten weider
Logge dich aus deinem SPN Account aus.
purge
User
GET /api/v1/spn/account/user/profile
gibt application/json Daten wieder
Erhalten das Nutzerprofil von dem eingeloggten SPN Account.
refresh
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/graph{format:\.[a-z]{2,4}}
gibt text/plain Daten wieder.
Gibt ein Diagramm der gegebenen SPN Karte wieder.
map (in path)
name of mapformat (in path)
file typeInternal
POST /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/intel/update
gibt text/plain Daten wieder
Aktualisiert die interne Daten der Karte.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/measurements
gibt application/json Daten wieder.
Gibt die Messungen der Karte wieder.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/measurements/table
gibt text/plain Daten wieder.
Gibt die Messungen der Karte als Tabelle wieder.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/optimization
gibt application/json Daten wieder
Gibt die kalkulierte Optimierung für die Karte wieder.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/optimization/table
gibt text/plain Daten wieder
Gibt die kalkulierte Optimierung für die Karte als Tabelle wieder.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/pins
gibt application/json Daten wieder
Gibt eine Liste von Pins auf der Karte wieder.
User
GET /api/v1/spn/map/{map:[A-Za-z0-9]{1,255}}/route/to/{destination:[a-z0-9_\.:-]{1,255}}
gibt text/plain Daten wieder
Gibt eine textuelle Representation von dem Routing Prozess wieder.
Admin
POST /api/v1/spn/reinit
gibt text/plain Daten wieder.
Stoppt das SPN, Setzt alle chaches zurück und startet sie neu. Der SPN Account und Einstellungen werden nicht geändert.
User
POST /api/v1/ui/reload
gibt text/plain Daten wieder
Entfernt alle Assets von dem Cache und läd die aktuelle (vermutlich aktualisierte) Version von der Festplatte neu, wenn angefragt.
User
POST /api/v1/updates/check
gibt text/plain Daten wieder.
Löst das Suchen nach Updates aus.