LogoLogo
✉️ Contact💬 Forum
Guides de data.gouv.fr
Guides de data.gouv.fr
  • Bienvenue
  • ❓Foire aux questions
  • Documentation de data.gouv.fr
    • Créer un compte utilisateur et rejoindre une organisation
    • Organisation
      • Créer une organisation
      • Suivre l'activité et modifier son organisation
      • Gérer les membres de son organisation
      • Certifier une organisation
      • Supprimer une organisation
    • Jeux de données
      • Publier un jeu de données
        • Publier une Base Adresse Locale
      • Gérer un jeu de données
      • Explorer un jeu de donnée
      • Télécharger le catalogue de données de data.gouv.fr
      • Accéder au catalogue via SPARQL
    • API
      • Publier une API
      • Gérer une API
      • Outils pour les administrations
        • Doctrine des API
        • Accompagnement humain
        • Datapass : Outil d'habilitations
        • Bouquets API Entreprise et API Particulier
    • Réutilisations
      • Publier une réutilisation
      • Gérer une réutilisation
    • Statistiques
    • Ressource communautaire
    • Moissonnage
      • Comprendre les limites du moissonnage
      • Les différents types de moissonneurs
      • Mettre en place un moissonneur
      • Analyser le rapport de moissonnage
      • Moissonnage des plateformes géographiques
    • API de data.gouv.fr
      • Prise en main de l'API
      • Tutoriel d'utilisation
      • Gérer un jeu de données par l'API
      • Référence
        • site
        • datasets
        • reuses
        • discussions
        • organizations
        • spatial
        • users
        • me
        • contacts
        • workers
        • tags
        • topics
        • posts
        • transfer
        • notifications
        • avatars
        • harvest
  • Guides open data
    • Guide juridique
      • Producteurs de données
        • Comprendre la notion d'open data
        • Qui est concerné ?
        • Quelles sont les obligations ?
      • Réutilisateurs de données
        • Respecter les conditions de réutilisation
      • Chronologie de l'open data
    • Guide qualité
      • Evaluer le niveau de qualité d'un jeu de données
      • Préparer un jeu de données de qualité
        • Extraire un jeu de données d'un système d'information
        • Structurer un jeu de données
          • Structurer une Base Adresse Locale
        • Lier des données à un référentiel
      • Documenter des données
        • Bien documenter un jeu de données
        • Diffuser la documentation d'un jeu de données
      • Améliorer la qualité d'un jeu de données en continu
        • Améliorer le score de qualité des métadonnées
        • Connaître et suivre les usages d'un jeu de données
        • Mettre en place une stratégie organisationnelle
      • Maîtriser les schémas de données
        • Comprendre les bénéfices d'utiliser un schéma de données
        • Créer un schéma de données
          • Etape 1 : Phase d'investigation
          • Etape 2 : Phase de concertation
          • Etape 3 : Phase de construction
          • Etape 4 : Phase de promotion et de maintien
          • Focus : Construire un schéma TableSchema
        • Intégrer un schéma de données à schema.data.gouv.fr
        • Produire des données en conformité avec un schéma
        • Indiquer et vérifier qu'une ressource respecte un schéma de données
  • Guides sur l'utilisation des données
    • Introduction à l'open data
      • Comprendre la notion d'open data
      • Comprendre l'écosystème de l'open data
      • Comprendre les conditions d'utilisation des données en open data
      • Découvrir et utiliser data.gouv.fr
    • Guide traitement et analyse de données
      • Trouver des données
      • Prendre connaissance et évaluer la qualité de données
      • Explorer des données
      • Récupérer des données
      • Manipuler des données
        • Ouvrir des données
        • Filtrer des données
        • Nettoyer des données
        • Croiser des données
        • Géocoder des adresses
      • Analyser des données
        • Analyser des données avec le tableur LibreOffice Calc
        • Analyser des données avec Python
        • Analyser des données avec R
      • Visualiser des données
      • Cartographier des données
      • Réaliser des projets utiles et s'inspirer
      • Poser des questions aux producteurs de données
      • Valoriser ses travaux
      • Autres ressources pédagogiques
    • Guide API géographiques
      • Utiliser l'API Adresse
        • Rappel sur les données adresses
        • Géocoder des adresses - théorie
        • Géocoder des adresses - cas pratiques
        • FAQ Adresse
      • Utiliser l'API Découpage administratif
      • Utiliser les tuiles vectorielles
    • Guide données du cadastre
      • Comprendre les données du cadastre et leurs usages
      • Manipuler les données du cadastre
      • Foire aux questions sur le cadastre
    • Guide données météorologiques
    • Guide API "Adresse" de l'IGN
  • Autres ressources utiles
    • Lexique de l'open data
    • Données de la commande publique
      • Publier les données essentielles d’attribution des marchés
      • Déclaration d’un profil d’acheteur
    • Données de forte valeur : métadonnées obligatoires et modalités de rapportage
    • Ressources OpenDataFrance
    • Documentation de transport.data.gouv.fr
    • Les algorithmes publics : pourquoi et comment les expliquer ?
      • Les algorithmes publics : enjeux et obligations
      • Fiche pratique : l'obligation de mention explicite
      • Fiche pratique : l'inventaire des principaux traitements algorithmiques
      • Liste de ressources
    • Codes sources du secteur public : lesquels ouvrir, pourquoi et comment ?
      • Ce document n'est pas...
      • Cadre juridique
    • Catalogage de données - GRIST
    • 📒Guide du participant au Hackathon Météo
      • Ressources du hackathon
        • Données
        • Prise en main des données
        • Outils
        • Programme
        • Informations pratiques
        • Contacts
      • Avant le hackathon
      • Pendant le hackathon : règles et bonnes pratiques
        • Choix du défi
        • Constitution des équipes
        • Sollicitation des mentors
        • Documentation des réalisations
        • Rendu intermédiaire
        • Soumission du projet
        • Evaluation des projets
      • Après le hackathon
        • Evaluation du hackathon
        • Valorisation de votre projet
Propulsé par GitBook
Sur cette page

Cet article vous a-t-il été utile ?

Modifier sur GitHub
Exporter en PDF
  1. Documentation de data.gouv.fr
  2. API de data.gouv.fr
  3. Référence

harvest

Harvest related operations

PrécédentavatarsSuivantGuides open data

Dernière mise à jour il y a 1 an

Cet article vous a-t-il été utile ?

List all available harvest backends

get
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/backends HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "extra_configs": [
    {
      "default": "text",
      "description": "text",
      "key": "text",
      "label": "text"
    }
  ],
  "features": [
    {
      "default": "text",
      "description": "text",
      "key": "text",
      "label": "text"
    }
  ],
  "filters": [
    {
      "description": "text",
      "key": "text",
      "label": "text",
      "type": "text"
    }
  ],
  "id": "text",
  "label": "text"
}

List all jobs for a given source

get
Paramètres de chemin
identanyRequis
Paramètres de requête
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/job/{ident}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "created": "2025-06-16T22:34:11.091Z",
  "ended": "2025-06-16T22:34:11.091Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-06-16T22:34:11.091Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-06-16T22:34:11.091Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "availability_url": "text",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-06-16T22:34:11.091Z",
        "datasets": {},
        "deleted_at": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-06-16T22:34:11.091Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-06-16T22:34:11.091Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-06-16T22:34:11.091Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "id": "text",
        "license": "text",
        "machine_documentation_url": "text",
        "metadata_modified_at": "2025-06-16T22:34:11.091Z",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "private": true,
        "rate_limiting": "text",
        "rate_limiting_url": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "tags": [
          "text"
        ],
        "technical_documentation_url": "text",
        "title": "My awesome API"
      },
      "dataset": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "page": "text",
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-06-16T22:34:11.091Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-06-16T22:34:11.091Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-06-16T22:34:11.091Z",
  "status": "pending"
}

List all available harvesters

get
Réponses
200
Success
application/json
Réponsestring[]
get
GET /api/1/harvest/job_status HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

[
  "text"
]

Get a single source given an ID or a slug

get
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}
delete
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
delete
DELETE /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}

List all jobs for a given source

get
Paramètres de chemin
identanyRequis
Paramètres de requête
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident}/jobs/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "data": [
    {
      "created": "2025-06-16T22:34:11.091Z",
      "ended": "2025-06-16T22:34:11.091Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2025-06-16T22:34:11.091Z",
          "dataservice": {
            "access_type": "open",
            "acronym": "text",
            "archived_at": "2025-06-16T22:34:11.091Z",
            "authorization_request_url": "text",
            "availability": "99.99",
            "availability_url": "text",
            "base_api_url": "text",
            "business_documentation_url": "text",
            "contact_points": [
              {
                "contact_form": "text",
                "email": "text",
                "id": "text",
                "name": "text",
                "organization": {
                  "class": "text",
                  "id": "text",
                  "acronym": "text",
                  "badges": [
                    {
                      "kind": "text"
                    }
                  ],
                  "logo": "text",
                  "logo_thumbnail": "text",
                  "name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                },
                "owner": {
                  "class": "text",
                  "id": "text",
                  "avatar": "text",
                  "avatar_thumbnail": "text",
                  "first_name": "text",
                  "last_name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                },
                "role": "text"
              }
            ],
            "created_at": "2025-06-16T22:34:11.091Z",
            "datasets": {},
            "deleted_at": "2025-06-16T22:34:11.091Z",
            "description": "text",
            "extras": {},
            "format": "REST",
            "harvest": {
              "archived_at": "2025-06-16T22:34:11.091Z",
              "archived_reason": "text",
              "backend": "text",
              "created_at": "2025-06-16T22:34:11.091Z",
              "domain": "text",
              "id": "text",
              "last_update": "2025-06-16T22:34:11.091Z",
              "remote_id": "text",
              "remote_url": "text",
              "source_id": "text",
              "source_url": "text",
              "uri": "text"
            },
            "id": "text",
            "license": "text",
            "machine_documentation_url": "text",
            "metadata_modified_at": "2025-06-16T22:34:11.091Z",
            "metrics": {},
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "private": true,
            "rate_limiting": "text",
            "rate_limiting_url": "text",
            "self_api_url": "text",
            "self_web_url": "text",
            "slug": "text",
            "tags": [
              "text"
            ],
            "technical_documentation_url": "text",
            "title": "My awesome API"
          },
          "dataset": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "page": "text",
            "title": "text",
            "uri": "text"
          },
          "ended": "2025-06-16T22:34:11.091Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "kwargs": {},
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2025-06-16T22:34:11.091Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2025-06-16T22:34:11.091Z",
      "status": "pending"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Preview a single harvest source given an ID or a slug

get
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident}/preview HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "created": "2025-06-16T22:34:11.091Z",
  "ended": "2025-06-16T22:34:11.091Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-06-16T22:34:11.091Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-06-16T22:34:11.091Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "availability_url": "text",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-06-16T22:34:11.091Z",
        "datasets": {},
        "deleted_at": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-06-16T22:34:11.091Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-06-16T22:34:11.091Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-06-16T22:34:11.091Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "id": "text",
        "license": "text",
        "machine_documentation_url": "text",
        "metadata_modified_at": "2025-06-16T22:34:11.091Z",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "private": true,
        "rate_limiting": "text",
        "rate_limiting_url": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "tags": [
          "text"
        ],
        "technical_documentation_url": "text",
        "title": "My awesome API"
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-06-16T22:34:11.091Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-06-16T22:34:11.091Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-06-16T22:34:11.091Z",
              "modified_at": "2025-06-16T22:34:11.091Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-06-16T22:34:11.091Z",
              "last_modified_internal": "2025-06-16T22:34:11.091Z"
            },
            "last_modified": "2025-06-16T22:34:11.091Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text",
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-06-16T22:34:11.091Z",
        "deleted": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-06-16T22:34:11.091Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-06-16T22:34:11.091Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-06-16T22:34:11.091Z",
          "modified_at": "2025-06-16T22:34:11.091Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-06-16T22:34:11.091Z",
          "last_modified_internal": "2025-06-16T22:34:11.091Z"
        },
        "last_modified": "2025-06-16T22:34:11.091Z",
        "last_update": "2025-06-16T22:34:11.091Z",
        "license": "notspecified",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "page": "text",
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-06-16T22:34:11.091Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-06-16T22:34:11.091Z",
              "modified_at": "2025-06-16T22:34:11.091Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-06-16T22:34:11.091Z",
              "last_modified_internal": "2025-06-16T22:34:11.091Z"
            },
            "last_modified": "2025-06-16T22:34:11.091Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text"
          }
        ],
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "slug": "text",
        "spatial": {
          "geom": {
            "coordinates": [
              {}
            ],
            "type": "Point"
          },
          "granularity": "other",
          "zones": {}
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-06-16T22:34:11.091Z",
          "start": "2025-06-16T22:34:11.091Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-06-16T22:34:11.091Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-06-16T22:34:11.091Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-06-16T22:34:11.091Z",
  "status": "pending"
}

Unschedule an harvest source

delete
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
delete
DELETE /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}

List all harvest sources

get
Paramètres de requête
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

ownerstringOptionnel

The organization or user ID to filter on

deletedbooleanOptionnel

Include sources flaggued as deleted

qstringOptionnel

The search query

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

[
  {
    "data": [
      {
        "active": false,
        "autoarchive": true,
        "backend": "csw-dcat",
        "config": {},
        "created_at": "2025-06-16T22:34:11.091Z",
        "deleted": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2025-06-16T22:34:11.091Z",
          "ended": "2025-06-16T22:34:11.091Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": [
            {
              "args": [
                "text"
              ],
              "created": "2025-06-16T22:34:11.091Z",
              "dataservice": {
                "access_type": "open",
                "acronym": "text",
                "archived_at": "2025-06-16T22:34:11.091Z",
                "authorization_request_url": "text",
                "availability": "99.99",
                "availability_url": "text",
                "base_api_url": "text",
                "business_documentation_url": "text",
                "contact_points": [
                  {
                    "contact_form": "text",
                    "email": "text",
                    "id": "text",
                    "name": "text",
                    "organization": {
                      "class": "text",
                      "id": "text",
                      "acronym": "text",
                      "badges": [
                        {
                          "kind": "text"
                        }
                      ],
                      "logo": "text",
                      "logo_thumbnail": "text",
                      "name": "text",
                      "page": "text",
                      "slug": "text",
                      "uri": "text"
                    },
                    "owner": {
                      "class": "text",
                      "id": "text",
                      "avatar": "text",
                      "avatar_thumbnail": "text",
                      "first_name": "text",
                      "last_name": "text",
                      "page": "text",
                      "slug": "text",
                      "uri": "text"
                    },
                    "role": "text"
                  }
                ],
                "created_at": "2025-06-16T22:34:11.091Z",
                "datasets": {},
                "deleted_at": "2025-06-16T22:34:11.091Z",
                "description": "text",
                "extras": {},
                "format": "REST",
                "harvest": {
                  "archived_at": "2025-06-16T22:34:11.091Z",
                  "archived_reason": "text",
                  "backend": "text",
                  "created_at": "2025-06-16T22:34:11.091Z",
                  "domain": "text",
                  "id": "text",
                  "last_update": "2025-06-16T22:34:11.091Z",
                  "remote_id": "text",
                  "remote_url": "text",
                  "source_id": "text",
                  "source_url": "text",
                  "uri": "text"
                },
                "id": "text",
                "license": "text",
                "machine_documentation_url": "text",
                "metadata_modified_at": "2025-06-16T22:34:11.091Z",
                "metrics": {},
                "organization": {
                  "class": "text",
                  "id": "text",
                  "acronym": "text",
                  "badges": [
                    {
                      "kind": "text"
                    }
                  ],
                  "logo": "text",
                  "logo_thumbnail": "text",
                  "name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                },
                "owner": {
                  "class": "text",
                  "id": "text",
                  "avatar": "text",
                  "avatar_thumbnail": "text",
                  "first_name": "text",
                  "last_name": "text",
                  "page": "text",
                  "slug": "text",
                  "uri": "text"
                },
                "private": true,
                "rate_limiting": "text",
                "rate_limiting_url": "text",
                "self_api_url": "text",
                "self_web_url": "text",
                "slug": "text",
                "tags": [
                  "text"
                ],
                "technical_documentation_url": "text",
                "title": "My awesome API"
              },
              "dataset": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "page": "text",
                "title": "text",
                "uri": "text"
              },
              "ended": "2025-06-16T22:34:11.091Z",
              "errors": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "kwargs": {},
              "logs": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "remote_id": "text",
              "started": "2025-06-16T22:34:11.091Z",
              "status": "pending"
            }
          ],
          "source": "text",
          "started": "2025-06-16T22:34:11.091Z",
          "status": "pending"
        },
        "name": "text",
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "schedule": "text",
        "url": "text",
        "validation": {
          "by": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "comment": "text",
          "on": "2025-06-16T22:34:11.091Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1
  }
]
  • GETList all available harvest backends
  • GETList all jobs for a given source
  • GETList all available harvesters
  • POSTPreview an harvesting from a source created with the given payload
  • GETGet a single source given an ID or a slug
  • PUTUpdate a harvest source
  • DELETE/harvest/source/{ident}
  • GETList all jobs for a given source
  • GETPreview a single harvest source given an ID or a slug
  • POSTSchedule an harvest source
  • DELETEUnschedule an harvest source
  • POSTValidate or reject an harvest source
  • GETList all harvest sources
  • POSTCreate a new harvest source

Preview an harvesting from a source created with the given payload

post
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
activebooleanRequis

Is this source active

Default: false
autoarchivebooleanRequis

If enabled, datasets not present on the remote source will be automatically archived

Default: true
backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:
configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses
200
Success
application/json
post
POST /api/1/harvest/source/preview HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "url": "text"
}
200

Success

{
  "created": "2025-06-16T22:34:11.091Z",
  "ended": "2025-06-16T22:34:11.091Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-06-16T22:34:11.091Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-06-16T22:34:11.091Z",
        "authorization_request_url": "text",
        "availability": "99.99",
        "availability_url": "text",
        "base_api_url": "text",
        "business_documentation_url": "text",
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-06-16T22:34:11.091Z",
        "datasets": {},
        "deleted_at": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-06-16T22:34:11.091Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-06-16T22:34:11.091Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-06-16T22:34:11.091Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "source_url": "text",
          "uri": "text"
        },
        "id": "text",
        "license": "text",
        "machine_documentation_url": "text",
        "metadata_modified_at": "2025-06-16T22:34:11.091Z",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "private": true,
        "rate_limiting": "text",
        "rate_limiting_url": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "slug": "text",
        "tags": [
          "text"
        ],
        "technical_documentation_url": "text",
        "title": "My awesome API"
      },
      "dataset": {
        "acronym": "text",
        "archived": "2025-06-16T22:34:11.091Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-06-16T22:34:11.091Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-06-16T22:34:11.091Z",
              "modified_at": "2025-06-16T22:34:11.091Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-06-16T22:34:11.091Z",
              "last_modified_internal": "2025-06-16T22:34:11.091Z"
            },
            "last_modified": "2025-06-16T22:34:11.091Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text",
            "dataset": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "page": "text",
              "title": "text",
              "uri": "text"
            },
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            }
          }
        ],
        "contact_points": [
          {
            "contact_form": "text",
            "email": "text",
            "id": "text",
            "name": "text",
            "organization": {
              "class": "text",
              "id": "text",
              "acronym": "text",
              "badges": [
                {
                  "kind": "text"
                }
              ],
              "logo": "text",
              "logo_thumbnail": "text",
              "name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "owner": {
              "class": "text",
              "id": "text",
              "avatar": "text",
              "avatar_thumbnail": "text",
              "first_name": "text",
              "last_name": "text",
              "page": "text",
              "slug": "text",
              "uri": "text"
            },
            "role": "text"
          }
        ],
        "created_at": "2025-06-16T22:34:11.091Z",
        "deleted": "2025-06-16T22:34:11.091Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-06-16T22:34:11.091Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-06-16T22:34:11.091Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-06-16T22:34:11.091Z",
          "modified_at": "2025-06-16T22:34:11.091Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-06-16T22:34:11.091Z",
          "last_modified_internal": "2025-06-16T22:34:11.091Z"
        },
        "last_modified": "2025-06-16T22:34:11.091Z",
        "last_update": "2025-06-16T22:34:11.091Z",
        "license": "notspecified",
        "metrics": {},
        "organization": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "owner": {
          "class": "text",
          "id": "text",
          "avatar": "text",
          "avatar_thumbnail": "text",
          "first_name": "text",
          "last_name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        },
        "page": "text",
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-06-16T22:34:11.091Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-06-16T22:34:11.091Z",
              "modified_at": "2025-06-16T22:34:11.091Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-06-16T22:34:11.091Z",
              "last_modified_internal": "2025-06-16T22:34:11.091Z"
            },
            "last_modified": "2025-06-16T22:34:11.091Z",
            "latest": "text",
            "metrics": {},
            "mime": "text",
            "preview_url": "text",
            "schema": {
              "name": "text",
              "url": "text",
              "version": "text"
            },
            "title": "text",
            "type": "main",
            "url": "text"
          }
        ],
        "schema": {
          "name": "text",
          "url": "text",
          "version": "text"
        },
        "slug": "text",
        "spatial": {
          "geom": {
            "coordinates": [
              {}
            ],
            "type": "Point"
          },
          "granularity": "other",
          "zones": {}
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-06-16T22:34:11.091Z",
          "start": "2025-06-16T22:34:11.091Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-06-16T22:34:11.091Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-06-16T22:34:11.091Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-06-16T22:34:11.091Z",
  "status": "pending"
}

Update a harvest source

put
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
activebooleanRequis

Is this source active

Default: false
autoarchivebooleanRequis

If enabled, datasets not present on the remote source will be automatically archived

Default: true
backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:
configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses
200
Success
application/json
put
PUT /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "url": "text"
}
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}

Schedule an harvest source

post
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
stringOptionnel
Réponses
200
Success
application/json
post
POST /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}

Validate or reject an harvest source

post
Paramètres de chemin
identanyRequis

A source ID or slug

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
byall ofLecture seuleOptionnel

Who performed the validation

commentstringOptionnel

A comment about the validation. Required on rejection

onstring · date-timeLecture seuleOptionnel

Date date on which validation was performed

statestring · enumRequis

Is it validated or not

Example: pendingValeurs possibles:
Réponses
200
Success
application/json
post
POST /api/1/harvest/source/{ident}/validate HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "comment": "text",
  "state": "pending"
}
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}

Create a new harvest source

post
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
activebooleanRequis

Is this source active

Default: false
autoarchivebooleanRequis

If enabled, datasets not present on the remote source will be automatically archived

Default: true
backendstring · enumRequis

The source backend

Example: csw-dcatValeurs possibles:
configobjectOptionnel

The configuration as key-value pairs

created_atstring · date-timeLecture seuleRequis

The source creation date

deletedstring · date-timeLecture seuleOptionnel

The source deletion date

descriptionstring · markdownOptionnel

The source description

idstringLecture seuleOptionnel

The source unique identifier

last_joball ofLecture seuleOptionnel

The last job for this source

namestringRequis

The source display name

organizationall ofOptionnel

The producer organization

ownerall ofOptionnel

The owner information

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

validationall ofLecture seuleOptionnel

Has the source been validated

Réponses
200
Success
application/json
post
POST /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "url": "text"
}
200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-06-16T22:34:11.091Z",
  "deleted": "2025-06-16T22:34:11.091Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-06-16T22:34:11.091Z",
    "ended": "2025-06-16T22:34:11.091Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-06-16T22:34:11.091Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-06-16T22:34:11.091Z",
          "authorization_request_url": "text",
          "availability": "99.99",
          "availability_url": "text",
          "base_api_url": "text",
          "business_documentation_url": "text",
          "contact_points": [
            {
              "contact_form": "text",
              "email": "text",
              "id": "text",
              "name": "text",
              "organization": {
                "class": "text",
                "id": "text",
                "acronym": "text",
                "badges": [
                  {
                    "kind": "text"
                  }
                ],
                "logo": "text",
                "logo_thumbnail": "text",
                "name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "owner": {
                "class": "text",
                "id": "text",
                "avatar": "text",
                "avatar_thumbnail": "text",
                "first_name": "text",
                "last_name": "text",
                "page": "text",
                "slug": "text",
                "uri": "text"
              },
              "role": "text"
            }
          ],
          "created_at": "2025-06-16T22:34:11.091Z",
          "datasets": {},
          "deleted_at": "2025-06-16T22:34:11.091Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-06-16T22:34:11.091Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-06-16T22:34:11.091Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-06-16T22:34:11.091Z",
            "remote_id": "text",
            "remote_url": "text",
            "source_id": "text",
            "source_url": "text",
            "uri": "text"
          },
          "id": "text",
          "license": "text",
          "machine_documentation_url": "text",
          "metadata_modified_at": "2025-06-16T22:34:11.091Z",
          "metrics": {},
          "organization": {
            "class": "text",
            "id": "text",
            "acronym": "text",
            "badges": [
              {
                "kind": "text"
              }
            ],
            "logo": "text",
            "logo_thumbnail": "text",
            "name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "owner": {
            "class": "text",
            "id": "text",
            "avatar": "text",
            "avatar_thumbnail": "text",
            "first_name": "text",
            "last_name": "text",
            "page": "text",
            "slug": "text",
            "uri": "text"
          },
          "private": true,
          "rate_limiting": "text",
          "rate_limiting_url": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "slug": "text",
          "tags": [
            "text"
          ],
          "technical_documentation_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "page": "text",
          "title": "text",
          "uri": "text"
        },
        "ended": "2025-06-16T22:34:11.091Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-06-16T22:34:11.091Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-06-16T22:34:11.091Z",
    "status": "pending"
  },
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "badges": [
      {
        "kind": "text"
      }
    ],
    "logo": "text",
    "logo_thumbnail": "text",
    "name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "first_name": "text",
    "last_name": "text",
    "page": "text",
    "slug": "text",
    "uri": "text"
  },
  "schedule": "text",
  "url": "text",
  "validation": {
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "on": "2025-06-16T22:34:11.091Z",
    "state": "pending"
  }
}