harvest | Guides de data.gouv.fr ⌘Ctrlk ✉️ Contact💬 Forum Plus Documentation de data.gouv.fr Guides sur les données Documentation de l’Annuaire des Entreprises Documentation ecologie.data.gouv.fr Fabrique des strandards Passe marché Accueil ❓Foire aux questions COMPTE UTILISATEUR Créer un compte utilisateur Suivre vos contenus publiés ORGANISATIONS Rejoindre une organisation Créer une organisation Modifier son organisation Gérer les membres de son organisation Suivre l'activité de son organisation Obtenir une certification JEUX DE DONNÉES Publier un jeu de données Ressource communautaire Modifier un jeu de données API Publier une API Modifier une API RÉUTILISATIONS Publier une réutilisation Modifier une réutilisation API DE DATA.GOUV.FR Prise en main Référencesite datasets reuses discussions organizations spatial users me contacts workers tags topics posts transfer notifications avatars harvest dataservices Télécharger le catalogue de données de data.gouv.fr Accéder au catalogue via SPARQL MOISSONNAGE Comprendre le moissonnage Mettre en place un moissonneur INTELLIGENCE ARTIFICIELLE Notre approche de l’intelligence artificielle sur data.gouv.fr Le serveur MCP de data.gouv.fr Le skill data.gouv.fr Données spécifiques Publier une Base Adresse Locale Données de forte valeur : métadonnées obligatoires et modalités de rapportage Données de la commande publique Données de transports et mobilités Autres Créer une verticale thématique de data.gouv.fr Propulsé par GitBook Sur cette page For the complete documentation index, see llms.txt. This page is also available as Markdown. Copier Sur cette page Documentation de data.gouv.fr API DE DATA.GOUV.FR Référence harvest Harvest related operations List all available harvest backends gethttp://www.data.gouv.fr/api/1/harvest/backends/ Paramètres d'en-tête X-Fieldsstring · maskOptionnelAn optional fields mask Réponses 200Success application/json extra_configsobject · HarvestExtraConfig[]OptionnelThe backend extra configuration variables Afficher propriétés featuresobject · HarvestFeature[]OptionnelThe backend optional features Afficher propriétés filtersobject · HarvestFilter[]OptionnelThe backend supported filters Afficher propriétés idstringOptionnelThe backend identifier labelstringOptionnelThe backend display name get/harvest/backends/ HTTP Copier GET /api/1/harvest/backends/ HTTP/1.1 Host: www.data.gouv.fr Accept: */* Tester 200Success Copier { "extra_configs": [ { "default": "text", "description": "text", "key": "text", "label": "text" } ], "features": [ { "default": true, "description": "text", "key": "text", "label": "text" } ], "filters": [ { "description": "text", "key": "text", "label": "text", "type": "text" } ], "id": "text", "label": "text" } List all harvest sources gethttp://www.data.gouv.fr/api/1/harvest/sources/ Paramètres de requête pageintegerOptionnelThe page to fetch Default: 1 page_sizeintegerOptionnelThe page size to fetch Default: 20 qstringOptionnel ownerstringOptionnel organizationstringOptionnel deletedbooleanOptionnelInclude sources flagged as deleted Default: false Paramètres d'en-tête X-Fieldsstring · maskOptionnelAn optional fields mask Réponses 200Success application/json dataobject · HarvestSource (read)[]OptionnelThe page data Afficher propriétés next_pagestringOptionnelThe next page URL if exists pageinteger · min: 1RequisThe current page page_sizeintegerRequisThe page size used for pagination previous_pagestringOptionnelThe previous page URL if exists totalintegerRequisThe total paginated items get/harvest/sources/ HTTP Copier GET /api/1/harvest/sources/ HTTP/1.1 Host: www.data.gouv.fr Accept: */* Tester 200Success Copier [ { "data": [ { "active": true, "autoarchive": true, "backend": "text", "config": {}, "created_at": "2026-01-01T00:00:00.000Z", "deleted": "2026-01-01T00:00:00.000Z", "description": "text", "id": "text", "last_job": { "created": "2026-01-01T00:00:00.000Z", "ended": "2026-01-01T00:00:00.000Z", "errors": [ { "created_at": "2026-01-01T00:00:00.000Z", "details": "text", "message": "text" } ], "id": "text", "items": {}, "source": { "class": "text", "id": "text" }, "started": "2026-01-01T00:00:00.000Z", "status": "pending" }, "name": "text", "organization": { "class": "text", "id": "text", "acronym": "text", "badges": [ { "kind": "text" } ], "logo": "text", "logo_thumbnail": "text", "name": "text", "page": "text", "permissions": { "delete": true, "edit": true, "harvest": true, "members": true, "private": true }, "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" }, "permissions": { "delete": true, "edit": true, "preview": true, "run": true, "schedule": true, "validate": true }, "schedule": "text", "slug": "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": "2026-01-01T00:00:00.000Z", "state": "pending" } } ], "next_page": "text", "page": 1, "page_size": 1, "previous_page": "text", "total": 1 } ] Update a harvest source puthttp://www.data.gouv.fr/api/1/harvest/source/{source}/ Paramètres de chemin sourcestringRequis Paramètres d'en-tête X-Fieldsstring · maskOptionnelAn optional fields mask Corps application/json activebooleanOptionnelIs this source active autoarchivebooleanOptionnelIf enabled, datasets not present on the remote source will be automatically archived backendstringRequisThe source backend configobjectOptionnelThe configuration as key-value pairs descriptionstring · markdownOptionnelThe source description namestring · max: 255OptionnelThe source display name organizationstringOptionnelOnly present if owner is not set. Can only be set to an organization of the current authenticated user. ownerstringOptionnelOnly present if organization is not set. Can only be set to the current authenticated user. urlstringRequisThe source base URL Réponses 200Success application/json activebooleanOptionnelIs this source active autoarchivebooleanOptionnelIf enabled, datasets not present on the remote source will be automatically archived backendstringRequisThe source backend configobjectOptionnelThe configuration as key-value pairs created_atstring · date-timeLecture seuleRequisThe source creation date deletedstring · date-timeLecture seuleOptionnelThe source deletion date descriptionstring · markdownOptionnelThe source description idstringLecture seuleRequis last_jobobject · HarvestJob (read)Optionnel Afficher propriétés namestring · max: 255OptionnelThe source display name organizationobject · OrganizationReferenceOptionnel Afficher propriétés ownerobject · UserReferenceOptionnel Afficher propriétés permissionsobject · HarvestSourcePermissionsOptionnel Afficher propriétés schedulestringLecture seuleOptionnelThe source schedule (interval or cron expression) slugstring · max: 255Lecture seuleRequisThe source permalink string urlstringRequisThe source base URL validationobject · HarvestSourceValidation (read)Optionnel Afficher propriétés put/harvest/source/{source}/ HTTP Copier PUT /api/1/harvest/source/{source}/ HTTP/1.1 Host: www.data.gouv.fr Content-Type: application/json Accept: */* Content-Length: 148 { "active": true, "autoarchive": true, "backend": "text", "config": {}, "description": "text", "name": "text", "organization": "text", "owner": "text", "url": "text" } Tester 200Success Copier { "active": true, "autoarchive": true, "backend": "text", "config": {}, "created_at": "2026-01-01T00:00:00.000Z", "deleted": "2026-01-01T00:00:00.000Z", "description": "text", "id": "text", "last_job": { "created": "2026-01-01T00:00:00.000Z", "ended": "2026-01-01T00:00:00.000Z", "errors": [ { "created_at": "2026-01-01T00:00:00.000Z", "details": "text", "message": "text" } ], "id": "text", "items": {}, "source": { "class": "text", "id": "text" }, "started": "2026-01-01T00:00:00.000Z", "status": "pending" }, "name": "text", "organization": { "class": "text", "id": "text", "acronym": "text", "badges": [ { "kind": "text" } ], "logo": "text", "logo_thumbnail": "text", "name": "text", "page": "text", "permissions": { "delete": true, "edit": true, "harvest": true, "members": true, "private": true }, "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" }, "permissions": { "delete": true, "edit": true, "preview": true, "run": true, "schedule": true, "validate": true }, "schedule": "text", "slug": "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": "2026-01-01T00:00:00.000Z", "state": "pending" } } Get a single job given an ID gethttp://www.data.gouv.fr/api/1/harvest/job/{ident}/ Paramètres de chemin identstringRequis Paramètres d'en-tête X-Fieldsstring · maskOptionnelAn optional fields mask Réponses 200Success application/json createdstring · date-timeLecture seuleRequisThe job creation date endedstring · date-timeLecture seuleOptionnelThe job end date errorsobject · HarvestError (read)Optionnel Afficher propriétés idstringLecture seuleRequis itemsobjectLecture seuleOptionnelVisit this API link to see the list. sourceobject · HarvestSourceReferenceOptionnel Afficher propriétés startedstring · date-timeLecture seuleOptionnelThe job start date statusstring · enumLecture seuleRequisThe job status Example: pendingValeurs possibles: pendinginitializinginitializedprocessingdonedone-errorsfailed get/harvest/job/{ident}/ HTTP Copier GET /api/1/harvest/job/{ident}/ HTTP/1.1 Host: www.data.gouv.fr Accept: */* Tester 200Success Copier { "created": "2026-01-01T00:00:00.000Z", "ended": "2026-01-01T00:00:00.000Z", "errors": [ { "created_at": "2026-01-01T00:00:00.000Z", "details": "text", "message": "text" } ], "id": "text", "items": {}, "source": { "class": "text", "id": "text" }, "started": "2026-01-01T00:00:00.000Z", "status": "pending" } Get a single source given an ID or a slug gethttp://www.data.gouv.fr/api/1/harvest/source/{source}/ Paramètres de chemin sourcestringRequis Paramètres d'en-tête X-Fieldsstring · maskOptionnelAn optional fields mask Réponses 200Success application/json activebooleanOptionnelIs this source active autoarchivebooleanOptionnelIf enabled, datasets not present on the remote source will be automatically archived backendstringRequisThe source backend configobjectOptionnelThe configuration as key-value pairs created_atstring · date-timeLecture seuleRequisThe source creation date deletedstring · date-timeLecture seuleOptionnelThe source deletion date descriptionstring · markdownOptionnelThe source description idstringLecture seuleRequis last_jobobject · HarvestJob (read)Optionnel Afficher propriétés namestring · max: 255OptionnelThe source display name organizationobject · OrganizationReferenceOptionnel Afficher propriétés ownerobject · UserReferenceOptionnel Afficher propriétés permissionsobject · HarvestSourcePermissionsOptionnel Afficher propriétés schedulestringLecture seuleOptionnelThe source schedule (interval or cron expression) slugstring · max: 255Lecture seuleRequisThe source permalink string urlstringRequisThe source base URL validationobject · HarvestSourceValidation (read)Optionnel Afficher propriétés get/harvest/source/{source}/ HTTP Copier GET /api/1/harvest/source/{source}/ HTTP/1.1 Host: www.data.gouv.fr Accept: */* Tester 200Success Copier { "active": true, "autoarchive": true, "backend": "text", "config": {}, "created_at": "2026-01-01T00:00:00.000Z", "deleted": "2026…