cdn.pizzaDocumentation

Développeurs

GraphQL

Le endpoint GraphQL actuel accepte un sous-ensemble volontairement limité de requêtes.

#Vue d’ensemble

Le endpoint GraphQL actuel accepte un sous-ensemble volontairement limité de requêtes.

#Sous-ensemble actuellement pris en charge

Le endpoint /api/graphql est protégé comme le reste de l’API. Il reconnaît les requêtes zones, files, stats et nodes, scoping chaque résultat à l’organisation authentifiée.

Le parseur actuel n’est pas un serveur GraphQL général: introspection, mutations, fragments complexes et champs arbitraires ne sont pas garantis. Une requête non prise en charge renvoie un tableau errors; les fichiers sont limités à 50 dans cette version.

#Envoyer une requête

  1. Placez le texte dans la propriété JSON query.

  2. Ajoutez variables seulement si votre requête les utilise.

  3. Contrôlez la présence de errors même avec une réponse HTTP JSON.

  4. Traitez les champs absents comme une incompatibilité, pas comme une valeur nulle supposée.

#Requêtes disponibles

Cette interface est un sous-ensemble de lecture, sans introspection ni mutation générale.

#zones

Toutes les zones de l’organisation.

Fields: id name domain isActive isVerified status region publicFilesReady

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

#files

Les 50 premiers fichiers visibles.

Fields: id uuid name size mimeType url publicPath

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

#stats

Agrégats des 30 derniers jours.

Fields: totalRequests totalBandwidth zonesCount filesCount

graphql
query {
  stats {
    totalRequests
    totalBandwidth
    zonesCount
    filesCount
  }
}

#nodes

Nœuds de l’organisation, sans adresse IP.

Fields: id hostname region status

graphql
query {
  nodes {
    id
    hostname
    region
    status
  }
}
Documentation clientRéférence générée depuis les interfaces publiées