Passer au contenu principal
POST
Lancer une tâche d’export statique
L’exportation statique nécessite un forfait Enterprise.

Autorisations

Authorization
string
header
requis

Clé d’API administrateur. Générez-en une sur la page des clés d’API de votre Dashboard.

Corps

application/json
domain
string
requis

Le domaine du déploiement à exporter, par exemple docs.example.com.

Exemple:

"docs.example.com"

version
string

Un libellé de version facultatif pour identifier cet export. Par défaut, il s’agit de la dernière version publiée.

Exemple:

"2024-06-01"

paths
string[]

Une liste facultative de chemins de page à inclure. Si elle est omise, toutes les pages publiées sont exportées.

Exemple:

Réponse

La tâche d’export a été acceptée et mise en file d’attente.

jobId
string
requis

Identifiant unique de la tâche d’export statique.

Exemple:

"se_3f9a2c1b8e7d4a06"

status
enum<string>
requis

L’état actuel de la tâche.

Options disponibles:
queued,
running,
completed,
failed
Exemple:

"running"

progress
number
requis

Pourcentage d’avancement de 0 à 100.

Plage requise: 0 <= x <= 100
Exemple:

42

pageCount
integer
requis

Le nombre de pages exportées jusqu’à présent.

Exemple:

128

createdAt
string<date-time>
requis

Date de création de la tâche.

updatedAt
string<date-time>
requis

Date de la dernière mise à jour de la tâche.

error
string | null

Un message d’erreur lisible par un humain. Présent uniquement lorsque status est failed.