harvest

Harvest related operations

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

idstringOptionnel

The backend identifier

labelstringOptionnel

The backend display name

get/harvest/backends/

HTTPcURLJavaScriptPython

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": true,
      "description": "text",
      "key": "text",
      "label": "text"
    }
  ],
  "filters": [
    {
      "description": "text",
      "key": "text",
      "label": "text",
      "type": "text"
    }
  ],
  "id": "text",
  "label": "text"
}

List all harvest sources

get

Paramètres de requête

pageintegerOptionnel

The page to fetch

Default: 1

page_sizeintegerOptionnel

The page size to fetch

Default: 20

qstringOptionnel

ownerstringOptionnel

organizationstringOptionnel

deletedbooleanOptionnel

Include sources flagged as deleted

Default: false

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/harvest/sources/

HTTPcURLJavaScriptPython

GET /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "data": [
      {
        "active": true,
        "autoarchive": true,
        "backend": "text",
        "config": {},
        "created_at": "2026-07-14T22:01:14.412Z",
        "deleted": "2026-07-14T22:01:14.412Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2026-07-14T22:01:14.412Z",
          "ended": "2026-07-14T22:01:14.412Z",
          "errors": [
            {
              "created_at": "2026-07-14T22:01:14.412Z",
              "details": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": {},
          "source": {
            "class": "text",
            "id": "text"
          },
          "started": "2026-07-14T22:01:14.412Z",
          "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-07-14T22:01:14.412Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1
  }
]

Update a harvest source

put

Paramètres de chemin

sourcestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

configobjectOptionnel

The configuration as key-value pairs

descriptionstring · markdownOptionnel

The source description

namestring · max: 255Optionnel

The source display name

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

urlstringRequis

The source base URL

Réponses

200

Success

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

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 seuleRequis

namestring · max: 255Optionnel

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

slugstring · max: 255Lecture seuleRequis

The source permalink string

urlstringRequis

The source base URL

put/harvest/source/{source}/

HTTPcURLJavaScriptPython

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"
}

200

Success

{
  "active": true,
  "autoarchive": true,
  "backend": "text",
  "config": {},
  "created_at": "2026-07-14T22:01:14.412Z",
  "deleted": "2026-07-14T22:01:14.412Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-07-14T22:01:14.412Z",
    "ended": "2026-07-14T22:01:14.412Z",
    "errors": [
      {
        "created_at": "2026-07-14T22:01:14.412Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": {},
    "source": {
      "class": "text",
      "id": "text"
    },
    "started": "2026-07-14T22:01:14.412Z",
    "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-07-14T22:01:14.412Z",
    "state": "pending"
  }
}

Get a single job given an ID

get

Paramètres de chemin

identstringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

createdstring · date-timeLecture seuleRequis

The job creation date

endedstring · date-timeLecture seuleOptionnel

The job end date

idstringLecture seuleRequis

itemsobjectLecture seuleOptionnel

Visit this API link to see the list.

startedstring · date-timeLecture seuleOptionnel

The job start date

statusstring · enumLecture seuleRequis

The job status

Example: pendingValeurs possibles:

get/harvest/job/{ident}/

HTTPcURLJavaScriptPython

GET /api/1/harvest/job/{ident}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "created": "2026-07-14T22:01:14.412Z",
  "ended": "2026-07-14T22:01:14.412Z",
  "errors": [
    {
      "created_at": "2026-07-14T22:01:14.412Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": {},
  "source": {
    "class": "text",
    "id": "text"
  },
  "started": "2026-07-14T22:01:14.412Z",
  "status": "pending"
}

Get a single source given an ID or a slug

get

Paramètres de chemin

sourcestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

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 seuleRequis

namestring · max: 255Optionnel

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

slugstring · max: 255Lecture seuleRequis

The source permalink string

urlstringRequis

The source base URL

get/harvest/source/{source}/

HTTPcURLJavaScriptPython

GET /api/1/harvest/source/{source}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": true,
  "autoarchive": true,
  "backend": "text",
  "config": {},
  "created_at": "2026-07-14T22:01:14.412Z",
  "deleted": "2026-07-14T22:01:14.412Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-07-14T22:01:14.412Z",
    "ended": "2026-07-14T22:01:14.412Z",
    "errors": [
      {
        "created_at": "2026-07-14T22:01:14.412Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": {},
    "source": {
      "class": "text",
      "id": "text"
    },
    "started": "2026-07-14T22:01:14.412Z",
    "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-07-14T22:01:14.412Z",
    "state": "pending"
  }
}

post

Paramètres de chemin

sourcestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

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 seuleRequis

namestring · max: 255Optionnel

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

slugstring · max: 255Lecture seuleRequis

The source permalink string

urlstringRequis

The source base URL

post/harvest/source/{source}/run/

HTTPcURLJavaScriptPython

POST /api/1/harvest/source/{source}/run/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": true,
  "autoarchive": true,
  "backend": "text",
  "config": {},
  "created_at": "2026-07-14T22:01:14.412Z",
  "deleted": "2026-07-14T22:01:14.412Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-07-14T22:01:14.412Z",
    "ended": "2026-07-14T22:01:14.412Z",
    "errors": [
      {
        "created_at": "2026-07-14T22:01:14.412Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": {},
    "source": {
      "class": "text",
      "id": "text"
    },
    "started": "2026-07-14T22:01:14.412Z",
    "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-07-14T22:01:14.412Z",
    "state": "pending"
  }
}

Create a new harvest source

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

configobjectOptionnel

The configuration as key-value pairs

descriptionstring · markdownOptionnel

The source description

namestring · max: 255Optionnel

The source display name

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

urlstringRequis

The source base URL

Réponses

200

Success

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

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 seuleRequis

namestring · max: 255Optionnel

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

slugstring · max: 255Lecture seuleRequis

The source permalink string

urlstringRequis

The source base URL

post/harvest/sources/

HTTPcURLJavaScriptPython

POST /api/1/harvest/sources/ 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"
}

200

Success

{
  "active": true,
  "autoarchive": true,
  "backend": "text",
  "config": {},
  "created_at": "2026-07-14T22:01:14.412Z",
  "deleted": "2026-07-14T22:01:14.412Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-07-14T22:01:14.412Z",
    "ended": "2026-07-14T22:01:14.412Z",
    "errors": [
      {
        "created_at": "2026-07-14T22:01:14.412Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": {},
    "source": {
      "class": "text",
      "id": "text"
    },
    "started": "2026-07-14T22:01:14.412Z",
    "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-07-14T22:01:14.412Z",
    "state": "pending"
  }
}

List all jobs for a given source

get

Paramètres de chemin

sourcestringRequis

Paramètres de requête

pageintegerOptionnel

The page to fetch

Default: 1

page_sizeintegerOptionnel

The page size to fetch

Default: 20

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

next_pagestringOptionnel

The next page URL if exists

pageinteger · min: 1Requis

The current page

page_sizeintegerRequis

The page size used for pagination

previous_pagestringOptionnel

The previous page URL if exists

totalintegerRequis

The total paginated items

get/harvest/source/{source}/jobs/

HTTPcURLJavaScriptPython

GET /api/1/harvest/source/{source}/jobs/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "created": "2026-07-14T22:01:14.412Z",
      "ended": "2026-07-14T22:01:14.412Z",
      "errors": [
        {
          "created_at": "2026-07-14T22:01:14.412Z",
          "details": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": {},
      "source": {
        "class": "text",
        "id": "text"
      },
      "started": "2026-07-14T22:01:14.412Z",
      "status": "pending"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

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

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

configobjectOptionnel

The configuration as key-value pairs

descriptionstring · markdownOptionnel

The source description

namestring · max: 255Optionnel

The source display name

organizationstringOptionnel

Only present if owner is not set. Can only be set to an organization of the current authenticated user.

ownerstringOptionnel

Only present if organization is not set. Can only be set to the current authenticated user.

urlstringRequis

The source base URL

Réponses

200

Success

application/json

createdstring · date-timeLecture seuleRequis

The job creation date

endedstring · date-timeLecture seuleOptionnel

The job end date

idstringLecture seuleRequis

startedstring · date-timeLecture seuleOptionnel

The job start date

statusstring · enumLecture seuleRequis

The job status

Example: pendingValeurs possibles:

post/harvest/source/preview/

HTTPcURLJavaScriptPython

POST /api/1/harvest/source/preview/ 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"
}

200

Success

{
  "created": "2026-07-14T22:01:14.412Z",
  "ended": "2026-07-14T22:01:14.412Z",
  "errors": [
    {
      "created_at": "2026-07-14T22:01:14.412Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2026-07-14T22:01:14.412Z",
      "dataservice": {
        "self_api_url": {},
        "self_web_url": {},
        "title": "My awesome API"
      },
      "dataset": {
        "access_audiences": [
          {
            "condition": "yes",
            "role": "local_authority_and_administration"
          }
        ],
        "access_type": "text",
        "access_type_reason": "text",
        "access_type_reason_category": "text",
        "acronym": "text",
        "archived": "2026-07-14T22:01:14.412Z",
        "authorization_request_url": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2026-07-14T22:01:14.412Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "issued_at": "2026-07-14T22:01:14.412Z",
              "last_update": "2026-07-14T22:01:14.412Z",
              "modified_at": "2026-07-14T22:01:14.412Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2026-07-14T22:01:14.412Z",
              "last_modified_internal": "2026-07-14T22:01:14.412Z"
            },
            "last_modified": "2026-07-14T22:01:14.412Z",
            "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"
            },
            "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,
              "edit_resources": true
            }
          }
        ],
        "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",
              "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"
            },
            "role": "contact"
          }
        ],
        "created_at": "2026-07-14T22:01:14.412Z",
        "deleted": "2026-07-14T22:01:14.412Z",
        "description": "text",
        "description_short": "text",
        "extras": {},
        "featured": true,
        "frequency": "continuous",
        "frequency_date": "2026-07-14T22:01:14.412Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2026-07-14T22:01:14.412Z",
          "backend": "text",
          "created_at": "2026-07-14T22:01:14.412Z",
          "dct_identifier": "text",
          "domain": "text",
          "issued_at": "2026-07-14T22:01:14.412Z",
          "last_update": "2026-07-14T22:01:14.412Z",
          "modified_at": "2026-07-14T22:01:14.412Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2026-07-14T22:01:14.412Z",
          "last_modified_internal": "2026-07-14T22:01:14.412Z"
        },
        "last_modified": "2026-07-14T22:01:14.412Z",
        "last_update": "2026-07-14T22:01:14.412Z",
        "license": "notspecified",
        "metrics": {},
        "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"
        },
        "page": {},
        "permissions": {
          "delete": true,
          "edit": true,
          "edit_resources": true
        },
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2026-07-14T22:01:14.412Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "issued_at": "2026-07-14T22:01:14.412Z",
              "last_update": "2026-07-14T22:01:14.412Z",
              "modified_at": "2026-07-14T22:01:14.412Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2026-07-14T22:01:14.412Z",
              "last_modified_internal": "2026-07-14T22:01:14.412Z"
            },
            "last_modified": "2026-07-14T22:01:14.412Z",
            "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": "2026-07-14T22:01:14.412Z",
          "start": "2026-07-14T22:01:14.412Z"
        },
        "title": "text",
        "uri": {}
      },
      "ended": "2026-07-14T22:01:14.412Z",
      "errors": [
        {
          "created_at": "2026-07-14T22:01:14.412Z",
          "details": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "remote_url": "text",
      "started": "2026-07-14T22:01:14.412Z",
      "status": "pending"
    }
  ],
  "source": {
    "class": "text",
    "id": "text"
  },
  "started": "2026-07-14T22:01:14.412Z",
  "status": "pending"
}

Preview a single harvest source given an ID or a slug

get

Paramètres de chemin

sourcestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

createdstring · date-timeLecture seuleRequis

The job creation date

endedstring · date-timeLecture seuleOptionnel

The job end date

idstringLecture seuleRequis

startedstring · date-timeLecture seuleOptionnel

The job start date

statusstring · enumLecture seuleRequis

The job status

Example: pendingValeurs possibles:

get/harvest/source/{source}/preview/

HTTPcURLJavaScriptPython

GET /api/1/harvest/source/{source}/preview/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "created": "2026-07-14T22:01:14.412Z",
  "ended": "2026-07-14T22:01:14.412Z",
  "errors": [
    {
      "created_at": "2026-07-14T22:01:14.412Z",
      "details": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2026-07-14T22:01:14.412Z",
      "dataservice": {
        "self_api_url": {},
        "self_web_url": {},
        "title": "My awesome API"
      },
      "dataset": {
        "access_audiences": [
          {
            "condition": "yes",
            "role": "local_authority_and_administration"
          }
        ],
        "access_type": "text",
        "access_type_reason": "text",
        "access_type_reason_category": "text",
        "acronym": "text",
        "archived": "2026-07-14T22:01:14.412Z",
        "authorization_request_url": "text",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2026-07-14T22:01:14.412Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "issued_at": "2026-07-14T22:01:14.412Z",
              "last_update": "2026-07-14T22:01:14.412Z",
              "modified_at": "2026-07-14T22:01:14.412Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2026-07-14T22:01:14.412Z",
              "last_modified_internal": "2026-07-14T22:01:14.412Z"
            },
            "last_modified": "2026-07-14T22:01:14.412Z",
            "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"
            },
            "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,
              "edit_resources": true
            }
          }
        ],
        "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",
              "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"
            },
            "role": "contact"
          }
        ],
        "created_at": "2026-07-14T22:01:14.412Z",
        "deleted": "2026-07-14T22:01:14.412Z",
        "description": "text",
        "description_short": "text",
        "extras": {},
        "featured": true,
        "frequency": "continuous",
        "frequency_date": "2026-07-14T22:01:14.412Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2026-07-14T22:01:14.412Z",
          "backend": "text",
          "created_at": "2026-07-14T22:01:14.412Z",
          "dct_identifier": "text",
          "domain": "text",
          "issued_at": "2026-07-14T22:01:14.412Z",
          "last_update": "2026-07-14T22:01:14.412Z",
          "modified_at": "2026-07-14T22:01:14.412Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2026-07-14T22:01:14.412Z",
          "last_modified_internal": "2026-07-14T22:01:14.412Z"
        },
        "last_modified": "2026-07-14T22:01:14.412Z",
        "last_update": "2026-07-14T22:01:14.412Z",
        "license": "notspecified",
        "metrics": {},
        "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"
        },
        "page": {},
        "permissions": {
          "delete": true,
          "edit": true,
          "edit_resources": true
        },
        "private": true,
        "quality": {},
        "resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2026-07-14T22:01:14.412Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "issued_at": "2026-07-14T22:01:14.412Z",
              "last_update": "2026-07-14T22:01:14.412Z",
              "modified_at": "2026-07-14T22:01:14.412Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2026-07-14T22:01:14.412Z",
              "last_modified_internal": "2026-07-14T22:01:14.412Z"
            },
            "last_modified": "2026-07-14T22:01:14.412Z",
            "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": "2026-07-14T22:01:14.412Z",
          "start": "2026-07-14T22:01:14.412Z"
        },
        "title": "text",
        "uri": {}
      },
      "ended": "2026-07-14T22:01:14.412Z",
      "errors": [
        {
          "created_at": "2026-07-14T22:01:14.412Z",
          "details": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "remote_url": "text",
      "started": "2026-07-14T22:01:14.412Z",
      "status": "pending"
    }
  ],
  "source": {
    "class": "text",
    "id": "text"
  },
  "started": "2026-07-14T22:01:14.412Z",
  "status": "pending"
}

delete

Paramètres de chemin

sourcestringRequis

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses

200

Success

application/json

activebooleanOptionnel

Is this source active

autoarchivebooleanOptionnel

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

backendstringRequis

The source backend

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 seuleRequis

namestring · max: 255Optionnel

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

slugstring · max: 255Lecture seuleRequis

The source permalink string

urlstringRequis

The source base URL

delete/harvest/source/{source}/

HTTPcURLJavaScriptPython

DELETE /api/1/harvest/source/{source}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "active": true,
  "autoarchive": true,
  "backend": "text",
  "config": {},
  "created_at": "2026-07-14T22:01:14.412Z",
  "deleted": "2026-07-14T22:01:14.412Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-07-14T22:01:14.412Z",
    "ended": "2026-07-14T22:01:14.412Z",
    "errors": [
      {
        "created_at": "2026-07-14T22:01:14.412Z",
        "details": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": {},
    "source": {
      "class": "text",
      "id": "text"
    },
    "started": "2026-07-14T22:01:14.412Z",
    "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-07-14T22:01:14.412Z",
    "state": "pending"
  }
}