harvest

Harvest related operations

Get a single job given an ID

get

Paramètres de chemin

identstringRequis

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

createdstring · date-timeRequis

The job creation date

endedstring · date-timeOptionnel

The job end date

idstringRequis

The job execution ID

sourcestringRequis

The source owning the job

startedstring · date-timeOptionnel

The job start date

statusstring · enumRequis

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-03-01T13:55:00.381Z",
  "ended": "2026-03-01T13:55:00.381Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2026-03-01T13:55:00.381Z",
      "dataservice": {
        "class": "text",
        "id": "text",
        "self_api_url": "text",
        "self_web_url": "text",
        "title": "My awesome API"
      },
      "dataset": {
        "class": "text",
        "id": "text"
      },
      "ended": "2026-03-01T13:55:00.381Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "remote_url": "text",
      "started": "2026-03-01T13:55:00.381Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2026-03-01T13:55:00.381Z",
  "status": "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

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": false,
        "autoarchive": true,
        "backend": "ckan",
        "config": {},
        "created_at": "2026-03-01T13:55:00.381Z",
        "deleted": "2026-03-01T13:55:00.381Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2026-03-01T13:55:00.381Z",
          "ended": "2026-03-01T13:55:00.381Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": [
            {
              "args": [
                "text"
              ],
              "created": "2026-03-01T13:55:00.381Z",
              "dataservice": {
                "class": "text",
                "id": "text",
                "self_api_url": "text",
                "self_web_url": "text",
                "title": "My awesome API"
              },
              "dataset": {
                "class": "text",
                "id": "text"
              },
              "ended": "2026-03-01T13:55:00.381Z",
              "errors": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "kwargs": {},
              "logs": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "remote_id": "text",
              "remote_url": "text",
              "started": "2026-03-01T13:55:00.381Z",
              "status": "pending"
            }
          ],
          "source": "text",
          "started": "2026-03-01T13:55:00.381Z",
          "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",
        "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-03-01T13:55:00.381Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1
  }
]

Create a new harvest source

post

Paramètres d'en-tête

X-Fieldsstring · maskOptionnel

An optional fields mask

Corps

application/json

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: ckanValeurs 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

namestringRequis

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

urlstringRequis

The source base URL

Réponses

200

Success

application/json

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: ckanValeurs 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

namestringRequis

The source display name

schedulestringLecture seuleOptionnel

The source schedule (interval or cron expression)

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: 290

{
  "active": false,
  "autoarchive": true,
  "backend": "ckan",
  "config": {},
  "description": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text"
  },
  "url": "text"
}

200

Success

{
  "active": false,
  "autoarchive": true,
  "backend": "ckan",
  "config": {},
  "created_at": "2026-03-01T13:55:00.381Z",
  "deleted": "2026-03-01T13:55:00.381Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2026-03-01T13:55:00.381Z",
    "ended": "2026-03-01T13:55:00.381Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2026-03-01T13:55:00.381Z",
        "dataservice": {
          "class": "text",
          "id": "text",
          "self_api_url": "text",
          "self_web_url": "text",
          "title": "My awesome API"
        },
        "dataset": {
          "class": "text",
          "id": "text"
        },
        "ended": "2026-03-01T13:55:00.381Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "remote_url": "text",
        "started": "2026-03-01T13:55:00.381Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2026-03-01T13:55:00.381Z",
    "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",
  "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-03-01T13:55:00.381Z",
    "state": "pending"
  }
}