cdn.pizzaDokumentation

Entwickler

GraphQL

Der aktuelle GraphQL-Endpoint akzeptiert bewusst nur einen begrenzten Query-Umfang.

#Überblick

Der aktuelle GraphQL-Endpoint akzeptiert bewusst nur einen begrenzten Query-Umfang.

#Aktuell unterstützter Umfang

Der Endpoint /api/graphql ist wie die übrige API geschützt. Er erkennt zones, files, stats und nodes und beschränkt alle Ergebnisse auf die authentifizierte Organisation.

Der Parser ist kein allgemeiner GraphQL-Server: Introspection, Mutations, komplexe Fragments und beliebige Felder sind nicht garantiert. Nicht unterstützte Queries liefern errors; Dateien sind derzeit auf 50 begrenzt.

#Query senden

  1. Legen Sie den Querytext in die JSON-Eigenschaft query.

  2. Fügen Sie variables nur bei Nutzung hinzu.

  3. Prüfen Sie auch bei JSON-Antwort auf errors.

  4. Behandeln Sie fehlende Felder als Inkompatibilität, nicht als angenommenes null.

#Verfügbare Abfragen

Diese Schnittstelle ist eine schreibgeschützte Teilmenge ohne Introspection oder allgemeine Mutationen.

#zones

Alle Zonen der Organisation.

Fields: id name domain isActive isVerified status region publicFilesReady

graphql
query {
  zones {
    id
    name
    domain
    isActive
    isVerified
    status
    region
    publicFilesReady
  }
}

#files

Die ersten 50 sichtbaren Dateien.

Fields: id uuid name size mimeType url publicPath

graphql
query {
  files {
    id
    uuid
    name
    size
    mimeType
    url
    publicPath
  }
}

#stats

Aggregate der letzten 30 Tage.

Fields: totalRequests totalBandwidth zonesCount filesCount

graphql
query {
  stats {
    totalRequests
    totalBandwidth
    zonesCount
    filesCount
  }
}

#nodes

Nodes der Organisation ohne IP-Adressen.

Fields: id hostname region status

graphql
query {
  nodes {
    id
    hostname
    region
    status
  }
}
KundendokumentationReferenz aus veröffentlichten Schnittstellen generiert