Entwickler

REST-API-Referenz

Diese Referenz folgt den tatsächlich verfügbaren Kundenrouten.

#Überblick

Diese Referenz folgt den tatsächlich verfügbaren Kundenrouten.

#Referenzoperation lesen

Jeder Eintrag nennt Methode, Pfad, Authentifizierung, Rolle, Parameter, Body, Antwort und Fehler. Pfad-IDs stammen aus Listen; leiten Sie IDs nie aus Anzeigenamen ab.

Collections verwenden data und können Metadaten enthalten. Uploads nutzen multipart/form-data, übliche Mutationen JSON. Beispiele enthalten Platzhalter; schreiben Sie keine echten Geheimnisse in die Shell-Historie.

#Vor Automatisierung

Rufen Sie /api/auth/me für Token und Organisation auf.
Listen Sie die Ressource und lesen Sie ihre ID.
Testen Sie die Mutation an einer unkritischen Ressource.
Behandeln Sie 401, 403, 404, 422, 429 und Timeouts ausdrücklich.

#REST-Operationen für Kunden

Basis-URL: https://api.cdn.pizzaOpenAPI 3.1 herunterladen

Authentication 3

POST /api/auth/login

Bei 2FA im Dashboard ein persönliches Token erstellen und direkt verwenden.

Authentifizierung: Keine
Rollen: Keine
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`email`	string	ja	Bestätigte E-Mail-Adresse.format: email
`password`	string	ja	Kontopasswort. Bei aktiver 2FA nicht akzeptiert.format: password
`device_name`	string	nein	Anzeigename des Tokens.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/auth/login' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"dev@example.com","password":"PASSWORD"}'

GET /api/auth/me

#Aktuelles Profil lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/auth/me' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/auth/logout

#Aktuelles Token widerrufen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/auth/logout' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Zones 3

GET /api/zones

#Zonen auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/zones' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/zones

#Zone erstellen, registrieren oder übertragen

Registrierung und Übertragung laufen asynchron und können 202 mit task_id liefern.

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201 202

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`domain`	string	ja	Vollqualifizierter Domainname.
`name`	string	nein	Anzeigename im Dashboard.length: 0…255
`type`	string	nein	Modus cname oder ns; Standard ist ns.enum: cname \| ns
`registrar_action`	string	nein	connect, register oder transfer.enum: connect \| register \| transfer
`transfer_auth_code`	string	nein	Für eine Übertragung erforderlich.length: 4…255
`registrant_name`	string	nein	Für Registrierung/Übertragung erforderlich.length: 0…255
`registrant_email`	string	nein	E-Mail des Domaininhabers.format: email · length: 0…255
`registrant_phone`	string	nein	Internationale Telefonnummer des Domaininhabers.length: 0…40
`registrant_organization`	string	nein	Organisation des Domaininhabers.length: 0…255
`registrant_street`	string	nein	Straße des Domaininhabers.length: 0…255
`registrant_city`	string	nein	Ort des Domaininhabers.length: 0…120
`registrant_postal_code`	string	nein	Postleitzahl des Domaininhabers.length: 0…30
`registrant_country_code`	string	nein	Zweistelliger ISO-Ländercode.length: 2…2
`private_whois`	string	nein	WHOIS-Datenschutzstufe.enum: FULL \| PARTIAL \| DISABLED

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/zones' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"domain":"assets.example.com"}'

GET /api/zones/{id}

#Zone lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Zonen-ID.

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/zones/ZONE_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Cache 2

POST /api/zones/{id}/purge

#Pfad aus dem Cache löschen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Zonen-ID.
`path`	string	nein	Zu löschender Pfad; ohne Angabe wird /* verwendet.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/zones/ZONE_ID/purge' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST /api/zones/{id}/purge-all

#Gesamte Zone leeren

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Zonen-ID.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/zones/ZONE_ID/purge-all' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Analytics 1

GET /api/zones/{id}/stats

#Zonenstatistiken lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Zonen-ID.
`period`	string	nein	Zeitraum 24h, 7d oder 30d; Standard 24h.enum: 24h \| 7d \| 30d · default: "24h"

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/zones/ZONE_ID/stats?period=24h' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Files 4

GET /api/files

#Dateien auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`zone_id`	integer	nein	Nach Zone filtern.
`per_page`	integer	nein	Seitengröße; Standard 25.range: 1…∞
`page`	integer	nein	Seitennummer.range: 1…∞

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/files?zone_id=42&per_page=25&page=1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/files

#Datei hochladen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`file`	string	ja	Datei, maximal 100 MB.format: binary
`zone_id`	integer	ja	Veröffentlichungszone.
`storage_nodes`	array<integer>	nein	Bis zu drei Storage-Node-IDs.
`cache_ttl`	integer	nein	Cache-TTL in Sekunden; 0 ist zulässig.range: 0…∞
`direct_public_link`	boolean	nein	Direkten Storage-Link aktivieren.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/files' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --form 'file=@./asset.png' \
  --form 'zone_id=42' \
  --form 'cache_ttl=3600' \
  --form 'direct_public_link=false'

GET /api/files/{uuid}

#Datei lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`uuid`	string	ja	Öffentliche UUID der Datei.format: uuid

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/files/FILE_UUID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

DELETE /api/files/{uuid}

#Datei löschen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`uuid`	string	ja	Öffentliche UUID der Datei.format: uuid

Beispiel

curl --request DELETE \
  --url 'https://api.cdn.pizza/api/files/FILE_UUID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Nodes 5

GET /api/nodes

#Verfügbare Nodes auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/nodes' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/nodes

#Kunden-Node erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`node_id`	string	ja	Eindeutige Node-ID.
`hostname`	string	ja	DNS-Hostname des Nodes.
`ip_address`	string	ja	IPv4- oder IPv6-Adresse des Nodes.
`region_id`	integer	ja	ID einer vorhandenen Region.
`country`	string	ja	Zweistelliger ISO-Ländercode.length: 2…2

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/nodes' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"node_id":"edge-zurich-01","hostname":"edge-zurich-01.example.net","ip_address":"203.0.113.42","region_id":1,"country":"CH"}'

GET /api/nodes/tokens

#BYOC-Tokens auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/nodes/tokens' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/nodes/tokens

#BYOC-Token erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`name`	string	nein	Tokenname.length: 0…100
`max_nodes`	integer	nein	Maximale Anzahl Nodes; Standard 1.default: 1 · range: 1…10
`expires_days`	integer	nein	Gültigkeit in Tagen; Standard 30.default: 30 · range: 1…365

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/nodes/tokens' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

DELETE /api/nodes/tokens/{id}

#BYOC-Token widerrufen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Token-ID.

Beispiel

curl --request DELETE \
  --url 'https://api.cdn.pizza/api/nodes/tokens/TOKEN_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

Private networks 5

GET /api/networks

#Private Netzwerke auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/networks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/networks

#Privates Netzwerk erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`name`	string	ja	Netzwerkname.length: 0…120
`private_cidr`	string	ja	Privater IPv4-Bereich.length: 0…32
`description`	string	nein	Betriebliche Beschreibung.length: 0…1000
`routes`	array<string>	nein	Angekündigte private Routen.items: 0…50
`vpn_type`	string	nein	wireguard.enum: wireguard

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/networks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"backoffice","private_cidr":"10.42.0.0/24"}'

GET /api/networks/{network}

#Privates Netzwerk lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`network`	integer	ja	Netzwerk-ID.

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/networks/NETWORK_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/networks/{network}/enrollment-keys

#Netzwerk-Einrichtungsschlüssel erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`network`	integer	ja	Netzwerk-ID.
`name`	string	ja	Schlüsselname.length: 0…120
`max_uses`	integer	nein	Maximale Anzahl Nutzungen.default: 1 · range: 1…10
`expires_in_hours`	integer	nein	Gültigkeitsdauer.default: 24 · range: 1…168

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/networks/NETWORK_ID/enrollment-keys' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"first-device"}'

POST /api/networks/enroll

#WireGuard-Peer einrichten

Authentifizierung: Einrichtungsschlüssel im Body
Rollen: Keine
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`enrollment_token`	string	ja	Kurzlebiger cpn_… Netzwerkschlüssel.length: 0…128
`name`	string	ja	Peer-Name.length: 0…120
`peer_type`	string	nein	connector, admin_device oder origin.enum: connector \| admin_device \| origin
`public_key`	string	ja	Öffentlicher WireGuard-Schlüssel.length: 0…120
`endpoint`	string	nein	Öffentlicher Endpoint des Peers.length: 0…255

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/networks/enroll' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"enrollment_token":"ENROLLMENT_TOKEN","name":"origin-geneva","public_key":"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="}'

Status agents 5

POST /api/status-agents/enrollment-keys

#Agent-Einrichtungsschlüssel erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`status_page_id`	integer	ja	Ziel-Statusseite.
`name`	string	ja	Schlüssel- oder Agentname.length: 0…120
`max_uses`	integer	nein	Maximale Anzahl Nutzungen.default: 1 · range: 1…10
`expires_in_hours`	integer	nein	Gültigkeitsdauer.default: 24 · range: 1…168

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/status-agents/enrollment-keys' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"status_page_id":1,"name":"branch-geneva"}'

POST /api/status-agents/enroll

#Status-Agent einrichten

Authentifizierung: Einrichtungsschlüssel im Body
Rollen: Keine
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`enrollment_token`	string	ja	Kurzlebiger cps_… Schlüssel.length: 0…128
`name`	string	ja	Agentname.length: 0…120
`hostname`	string	nein	Hostname der Maschine.length: 0…255
`version`	string	nein	Agentversion.length: 0…80
`capabilities`	array<string>	nein	Unterstützte Prüfarten.items: 0…20

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/status-agents/enroll' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"enrollment_token":"STATUS_ENROLLMENT_TOKEN","name":"branch-geneva"}'

GET /api/status-agents/config

#Agentkonfiguration lesen

Authentifizierung: Bearer-Token des Agents
Rollen: Keine
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/status-agents/config' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer STATUS_AGENT_TOKEN'

POST /api/status-agents/heartbeat

#Agent-Heartbeat senden

Authentifizierung: Bearer-Token des Agents
Rollen: Keine
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`hostname`	string	nein	Aktueller Hostname.length: 0…255
`version`	string	nein	Aktuelle Version.length: 0…80
`capabilities`	array<string>	nein	Unterstützte Funktionen, maximal zwanzig.items: 0…20
`metrics`	object	nein	Sichere lokale Messwerte wie Last und Speichernutzung.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/status-agents/heartbeat' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer STATUS_AGENT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST /api/status-agents/results

#Prüfergebnisse senden

Authentifizierung: Bearer-Token des Agents
Rollen: Keine
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`results`	array<object>	ja	Ein bis hundert Ergebnisse mit monitor_id und healthy; configuration_version, latency_ms, checked_at, details und error_message sind optional.items: 1…100

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/status-agents/results' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer STATUS_AGENT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"results":[{"monitor_id":17,"configuration_version":2,"healthy":true,"latency_ms":42.5}]}'

Partner POPs 3

GET /api/partner-pops

#Partner-POPs auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/partner-pops' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/partner-pops

#Partner-POP erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`company_name`	string	ja	Rechtlicher oder geschäftlicher Name des Betreibers.length: 0…160
`display_name`	string	ja	Vorgeschlagener öffentlicher POP-Name.length: 0…180
`contact_email`	string	ja	Betriebliche E-Mail des Partners.format: email · length: 0…180
`website_url`	string	nein	Öffentliche Website des Betreibers.format: uri · length: 0…255
`logo_url`	string	nein	HTTPS-URL des öffentlichen Logos.format: uri · length: 0…2048
`provider_name`	string	nein	Name des Infrastrukturanbieters.length: 0…160
`city`	string	ja	Stadt des POPs.length: 0…120
`country`	string	ja	Zweistelliger ISO-Ländercode.length: 2…2
`submitted_ipv4`	string	nein	Vorgeschlagene IPv4-Adresse.format: ipv4
`submitted_ipv6`	string	nein	Vorgeschlagene IPv6-Adresse.format: ipv6
`capacity_mbps`	integer	ja	Netzwerkkapazität in Mbit/s.range: 100…1000000
`notes`	string	nein	Technische oder betriebliche Hinweise.length: 0…5000
`requirements_accepted`	boolean	ja	Bestätigt die Annahme der Partner-POP-Anforderungen.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/partner-pops' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"company_name":"Example Networks AG","display_name":"Zurich IX","contact_email":"noc@example.net","city":"Zürich","country":"CH","capacity_mbps":10000,"requirements_accepted":true}'

POST /api/partner-pops/{partnerPop}/enrollment-token

#POP-Installationstoken erstellen

Der POP muss zur Organisation gehören. Auch der Antragsteller darf das Token erstellen.

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`partnerPop`	integer	ja	POP-ID.
`name`	string	nein	Name des Installationstokens.length: 0…120

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/partner-pops/PARTNER_POP_ID/enrollment-token' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

Privacy 4

GET /api/gdpr/export

#Kontodaten exportieren

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/gdpr/export' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

DELETE /api/gdpr/account

#Konto löschen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`password`	string	ja	Aktuelles Passwort zur Bestätigung erforderlich.format: password

Beispiel

curl --request DELETE \
  --url 'https://api.cdn.pizza/api/gdpr/account' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"password":"ACCOUNT_PASSWORD"}'

GET /api/gdpr/consent

#Einwilligungen lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/gdpr/consent' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

PUT /api/gdpr/consent

#Einwilligungen ändern

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`analytics`	boolean	nein	Nicht notwendige Analysen erlauben.
`marketing`	boolean	nein	Marketingkommunikation erlauben.

Beispiel

curl --request PUT \
  --url 'https://api.cdn.pizza/api/gdpr/consent' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

Billing 3

GET /api/billing/plans

#Tarife auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/billing/plans' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

GET /api/billing

#Aktuelles Abonnement lesen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/billing' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/billing/checkout

#Checkout-Sitzung erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`plan`	string	ja	Öffentlicher Tarifcode.enum: starter \| pro \| enterprise

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/billing/checkout' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"plan":"pro"}'

Webhooks 3

GET /api/webhooks

#Webhooks auflisten

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Beispiel

curl --request GET \
  --url 'https://api.cdn.pizza/api/webhooks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

POST /api/webhooks

#Webhook erstellen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 201

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`url`	string	ja	Öffentliche HTTP(S)-Empfänger-URL; HTTPS wird empfohlen.format: uri · length: 0…500
`events`	array<string>	ja	Abonnierte Ereignisse.items: file.uploaded \| file.deleted \| domain.created \| zone.created \| zone.updated \| zone.deleted \| cache.purged \| node.online \| node.offline \| node.deployed \| billing.updated \| invoice.paid \| mail.accepted \| mail.rejected \| mail.deferred
`secret`	string	nein	Vom Kunden gewähltes Signaturgeheimnis.length: 0…255

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/webhooks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://hooks.example.com/cdn-pizza","events":["file.uploaded","file.deleted"]}'

DELETE /api/webhooks/{id}

#Webhook löschen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`id`	integer	ja	Webhook-ID.

Beispiel

curl --request DELETE \
  --url 'https://api.cdn.pizza/api/webhooks/WEBHOOK_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

GraphQL 1

POST /api/graphql

#GraphQL-Abfrage ausführen

Authentifizierung: Persönliches Bearer-Token
Rollen: owner, admin, member, viewer
Erfolg: 200

Anfragefelder

Feld	Typ	Erforderlich	Beschreibung
`query`	string	ja	Query-Dokument; nur vier Root-Felder sind verfügbar.
`variables`	object	nein	Variablen der Abfrage.

Beispiel

curl --request POST \
  --url 'https://api.cdn.pizza/api/graphql' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"query":"query { zones { id domain } }"}'

#Überblick

#Referenzoperation lesen

#Vor Automatisierung

#REST-Operationen für Kunden

Authentication 3

#API-Sitzungstoken erstellen

Anfragefelder

#Aktuelles Profil lesen

#Aktuelles Token widerrufen

Zones 3

#Zonen auflisten

#Zone erstellen, registrieren oder übertragen

Anfragefelder

#Zone lesen

Anfragefelder

Cache 2

#Pfad aus dem Cache löschen

Anfragefelder

#Gesamte Zone leeren

Anfragefelder

Analytics 1

#Zonenstatistiken lesen

Anfragefelder

Files 4

#Dateien auflisten

Anfragefelder

#Datei hochladen

Anfragefelder

#Datei lesen

Anfragefelder

#Datei löschen

Anfragefelder

Nodes 5

#Verfügbare Nodes auflisten

#Kunden-Node erstellen

Anfragefelder

#BYOC-Tokens auflisten

#BYOC-Token erstellen

Anfragefelder

#BYOC-Token widerrufen

Anfragefelder

Private networks 5

#Private Netzwerke auflisten

#Privates Netzwerk erstellen

Anfragefelder

#Privates Netzwerk lesen

Anfragefelder

#Netzwerk-Einrichtungsschlüssel erstellen

Anfragefelder

#WireGuard-Peer einrichten

Anfragefelder

Status agents 5

#Agent-Einrichtungsschlüssel erstellen

Anfragefelder

#Status-Agent einrichten

Anfragefelder

#Agentkonfiguration lesen

#Agent-Heartbeat senden

Anfragefelder

#Prüfergebnisse senden

Anfragefelder

Partner POPs 3

#Partner-POPs auflisten

#Partner-POP erstellen

Anfragefelder

#POP-Installationstoken erstellen

Anfragefelder

Privacy 4

#Kontodaten exportieren

#Konto löschen

Anfragefelder

#Einwilligungen lesen

#Einwilligungen ändern

Anfragefelder

Billing 3

#Tarife auflisten

#Aktuelles Abonnement lesen

#Checkout-Sitzung erstellen

Anfragefelder

Webhooks 3