harvest

Harvest related operations

List all available harvest backends

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/backends'

200

200

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

Success

List all jobs for a given source

get

Path parameters

identanyrequired

Query parameters

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/job/{ident}/'

200

200

{
  "created": "2025-03-25T04:04:05.785Z",
  "ended": "2025-03-25T04:04:05.785Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-03-25T04:04:05.785Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
        "datasets": {},
        "deleted_at": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-03-25T04:04:05.785Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-03-25T04:04:05.785Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-03-25T04:04:05.785Z",
  "status": "pending"
}

Success

List all available harvesters

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/job_status'

200

200

[
  "text"
]

Success

Preview an harvesting from a source created with the given payload

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

activeboolean · default: falserequired

Is this source active

autoarchiveboolean · default: truerequired

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

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

configobjectoptional

The configuration as key-value pairs

created_atstring · date-timeread-onlyrequired

The source creation date

deletedstring · date-timeread-onlyoptional

The source deletion date

descriptionstring · markdownoptional

The source description

idstringread-onlyoptional

The source unique identifier

last_joball ofread-onlyoptional

The last job for this source

namestringrequired

The source display name

organizationall ofoptional

The producer organization

ownerall ofoptional

The owner information

schedulestringread-onlyoptional

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

validationall ofread-onlyoptional

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/preview' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "autoarchive": true,
    "backend": "csw-dcat",
    "config": {},
    "description": "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"
    },
    "url": "text"
  }'

application/json

200

200

{
  "created": "2025-03-25T04:04:05.785Z",
  "ended": "2025-03-25T04:04:05.785Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-03-25T04:04:05.785Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
        "datasets": {},
        "deleted_at": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-03-25T04:04:05.785Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-03-25T04:04:05.785Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-03-25T04:04:05.785Z",
              "modified_at": "2025-03-25T04:04:05.785Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-03-25T04:04:05.785Z",
              "last_modified_internal": "2025-03-25T04:04:05.785Z"
            },
            "last_modified": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
        "deleted": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-03-25T04:04:05.785Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-03-25T04:04:05.785Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-03-25T04:04:05.785Z",
          "modified_at": "2025-03-25T04:04:05.785Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T04:04:05.785Z",
          "last_modified_internal": "2025-03-25T04:04:05.785Z"
        },
        "last_modified": "2025-03-25T04:04:05.785Z",
        "last_update": "2025-03-25T04:04:05.785Z",
        "license": "text",
        "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-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-03-25T04:04:05.785Z",
              "modified_at": "2025-03-25T04:04:05.785Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-03-25T04:04:05.785Z",
              "last_modified_internal": "2025-03-25T04:04:05.785Z"
            },
            "last_modified": "2025-03-25T04:04:05.785Z",
            "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": "text",
          "zones": [
            "text"
          ]
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-03-25T04:04:05.785Z",
          "start": "2025-03-25T04:04:05.785Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-03-25T04:04:05.785Z",
  "status": "pending"
}

Success

Get a single source given an ID or a slug

get

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}'

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

Update a harvest source

put

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

activeboolean · default: falserequired

Is this source active

autoarchiveboolean · default: truerequired

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

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

configobjectoptional

The configuration as key-value pairs

created_atstring · date-timeread-onlyrequired

The source creation date

deletedstring · date-timeread-onlyoptional

The source deletion date

descriptionstring · markdownoptional

The source description

idstringread-onlyoptional

The source unique identifier

last_joball ofread-onlyoptional

The last job for this source

namestringrequired

The source display name

organizationall ofoptional

The producer organization

ownerall ofoptional

The owner information

schedulestringread-onlyoptional

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

validationall ofread-onlyoptional

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "autoarchive": true,
    "backend": "csw-dcat",
    "config": {},
    "description": "text",
    "last_job": {
      "created": "2025-03-25T04:04:05.785Z",
      "ended": "2025-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2025-03-25T04:04:05.785Z",
          "dataservice": {
            "access_type": "open",
            "acronym": "text",
            "archived_at": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
            "datasets": {},
            "deleted_at": "2025-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "format": "REST",
            "harvest": {
              "archived_at": "2025-03-25T04:04:05.785Z",
              "archived_reason": "text",
              "backend": "text",
              "created_at": "2025-03-25T04:04:05.785Z",
              "domain": "text",
              "id": "text",
              "last_update": "2025-03-25T04:04:05.785Z",
              "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-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "kwargs": {},
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2025-03-25T04:04:05.785Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "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"
    },
    "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-03-25T04:04:05.785Z",
      "state": "pending"
    }
  }'

application/json

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

delete

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}'

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

List all jobs for a given source

get

Path parameters

identanyrequired

Query parameters

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}/jobs/'

200

200

{
  "data": [
    {
      "created": "2025-03-25T04:04:05.785Z",
      "ended": "2025-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2025-03-25T04:04:05.785Z",
          "dataservice": {
            "access_type": "open",
            "acronym": "text",
            "archived_at": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
            "datasets": {},
            "deleted_at": "2025-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "format": "REST",
            "harvest": {
              "archived_at": "2025-03-25T04:04:05.785Z",
              "archived_reason": "text",
              "backend": "text",
              "created_at": "2025-03-25T04:04:05.785Z",
              "domain": "text",
              "id": "text",
              "last_update": "2025-03-25T04:04:05.785Z",
              "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-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "kwargs": {},
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2025-03-25T04:04:05.785Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "status": "pending"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Success

Preview a single harvest source given an ID or a slug

get

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}/preview'

200

200

{
  "created": "2025-03-25T04:04:05.785Z",
  "ended": "2025-03-25T04:04:05.785Z",
  "errors": [
    {
      "level": "text",
      "message": "text"
    }
  ],
  "id": "text",
  "items": [
    {
      "args": [
        "text"
      ],
      "created": "2025-03-25T04:04:05.785Z",
      "dataservice": {
        "access_type": "open",
        "acronym": "text",
        "archived_at": "2025-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
        "datasets": {},
        "deleted_at": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "extras": {},
        "format": "REST",
        "harvest": {
          "archived_at": "2025-03-25T04:04:05.785Z",
          "archived_reason": "text",
          "backend": "text",
          "created_at": "2025-03-25T04:04:05.785Z",
          "domain": "text",
          "id": "text",
          "last_update": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "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-03-25T04:04:05.785Z",
        "badges": [
          {
            "kind": "text"
          }
        ],
        "community_resources": [
          {
            "checksum": {
              "type": "sha1",
              "value": "text"
            },
            "created_at": "2025-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-03-25T04:04:05.785Z",
              "modified_at": "2025-03-25T04:04:05.785Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-03-25T04:04:05.785Z",
              "last_modified_internal": "2025-03-25T04:04:05.785Z"
            },
            "last_modified": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
        "deleted": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "extras": {},
        "featured": true,
        "frequency": "unknown",
        "frequency_date": "2025-03-25T04:04:05.785Z",
        "harvest": {
          "archived": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "backend": "text",
          "ckan_name": "text",
          "ckan_source": "text",
          "created_at": "2025-03-25T04:04:05.785Z",
          "dct_identifier": "text",
          "domain": "text",
          "last_update": "2025-03-25T04:04:05.785Z",
          "modified_at": "2025-03-25T04:04:05.785Z",
          "remote_id": "text",
          "remote_url": "text",
          "source_id": "text",
          "uri": "text"
        },
        "id": "text",
        "internal": {
          "created_at_internal": "2025-03-25T04:04:05.785Z",
          "last_modified_internal": "2025-03-25T04:04:05.785Z"
        },
        "last_modified": "2025-03-25T04:04:05.785Z",
        "last_update": "2025-03-25T04:04:05.785Z",
        "license": "text",
        "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-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "filesize": 1,
            "filetype": "file",
            "format": "text",
            "harvest": {
              "created_at": "2025-03-25T04:04:05.785Z",
              "modified_at": "2025-03-25T04:04:05.785Z",
              "uri": "text"
            },
            "id": "text",
            "internal": {
              "created_at_internal": "2025-03-25T04:04:05.785Z",
              "last_modified_internal": "2025-03-25T04:04:05.785Z"
            },
            "last_modified": "2025-03-25T04:04:05.785Z",
            "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": "text",
          "zones": [
            "text"
          ]
        },
        "tags": [
          "text"
        ],
        "temporal_coverage": {
          "end": "2025-03-25T04:04:05.785Z",
          "start": "2025-03-25T04:04:05.785Z"
        },
        "title": "text",
        "uri": "text"
      },
      "ended": "2025-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "kwargs": {},
      "logs": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "remote_id": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "status": "pending"
    }
  ],
  "source": "text",
  "started": "2025-03-25T04:04:05.785Z",
  "status": "pending"
}

Success

Schedule an harvest source

post

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

stringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}/schedule' \
  --header 'Content-Type: application/json' \
  --data '"text"'

application/json

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

Unschedule an harvest source

delete

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}/schedule'

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

Validate or reject an harvest source

post

Path parameters

identanyrequired

A source ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

byall ofread-onlyoptional

Who performed the validation

commentstringoptional

A comment about the validation. Required on rejection

onstring · date-timeread-onlyoptional

Date date on which validation was performed

statestring · enumrequired

Is it validated or not

Example: pending

Options: pending, accepted, refused

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/harvest/source/{ident}/validate' \
  --header 'Content-Type: application/json' \
  --data '{
    "by": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "first_name": "text",
      "last_name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    },
    "comment": "text",
    "state": "pending"
  }'

application/json

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success

List all harvest sources

get

Query parameters

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

owneranyoptional

The organization or user ID to filter on

deletedanyoptional

Include sources flaggued as deleted

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/harvest/sources/'

200

200

[
  {
    "data": [
      {
        "active": true,
        "autoarchive": true,
        "backend": "csw-dcat",
        "config": {},
        "created_at": "2025-03-25T04:04:05.785Z",
        "deleted": "2025-03-25T04:04:05.785Z",
        "description": "text",
        "id": "text",
        "last_job": {
          "created": "2025-03-25T04:04:05.785Z",
          "ended": "2025-03-25T04:04:05.785Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "id": "text",
          "items": [
            {
              "args": [
                "text"
              ],
              "created": "2025-03-25T04:04:05.785Z",
              "dataservice": {
                "access_type": "open",
                "acronym": "text",
                "archived_at": "2025-03-25T04:04:05.785Z",
                "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-03-25T04:04:05.785Z",
                "datasets": {},
                "deleted_at": "2025-03-25T04:04:05.785Z",
                "description": "text",
                "extras": {},
                "format": "REST",
                "harvest": {
                  "archived_at": "2025-03-25T04:04:05.785Z",
                  "archived_reason": "text",
                  "backend": "text",
                  "created_at": "2025-03-25T04:04:05.785Z",
                  "domain": "text",
                  "id": "text",
                  "last_update": "2025-03-25T04:04:05.785Z",
                  "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-03-25T04:04:05.785Z",
                "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-03-25T04:04:05.785Z",
              "errors": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "kwargs": {},
              "logs": [
                {
                  "level": "text",
                  "message": "text"
                }
              ],
              "remote_id": "text",
              "started": "2025-03-25T04:04:05.785Z",
              "status": "pending"
            }
          ],
          "source": "text",
          "started": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "state": "pending"
        }
      }
    ],
    "next_page": "text",
    "page": 1,
    "page_size": 1,
    "previous_page": "text",
    "total": 1
  }
]

Success

Create a new harvest source

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

activeboolean · default: falserequired

Is this source active

autoarchiveboolean · default: truerequired

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

backendstring · enumrequired

The source backend

Example: csw-dcat

Options: csw-dcat, csw-iso-19139, dcat, ckan, dkan, maaf

configobjectoptional

The configuration as key-value pairs

created_atstring · date-timeread-onlyrequired

The source creation date

deletedstring · date-timeread-onlyoptional

The source deletion date

descriptionstring · markdownoptional

The source description

idstringread-onlyoptional

The source unique identifier

last_joball ofread-onlyoptional

The last job for this source

namestringrequired

The source display name

organizationall ofoptional

The producer organization

ownerall ofoptional

The owner information

schedulestringread-onlyoptional

The source schedule (interval or cron expression)

urlstringrequired

The source base URL

validationall ofread-onlyoptional

Has the source been validated

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/harvest/sources/' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "autoarchive": true,
    "backend": "csw-dcat",
    "config": {},
    "description": "text",
    "last_job": {
      "created": "2025-03-25T04:04:05.785Z",
      "ended": "2025-03-25T04:04:05.785Z",
      "errors": [
        {
          "level": "text",
          "message": "text"
        }
      ],
      "id": "text",
      "items": [
        {
          "args": [
            "text"
          ],
          "created": "2025-03-25T04:04:05.785Z",
          "dataservice": {
            "access_type": "open",
            "acronym": "text",
            "archived_at": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
            "datasets": {},
            "deleted_at": "2025-03-25T04:04:05.785Z",
            "description": "text",
            "extras": {},
            "format": "REST",
            "harvest": {
              "archived_at": "2025-03-25T04:04:05.785Z",
              "archived_reason": "text",
              "backend": "text",
              "created_at": "2025-03-25T04:04:05.785Z",
              "domain": "text",
              "id": "text",
              "last_update": "2025-03-25T04:04:05.785Z",
              "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-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "errors": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "kwargs": {},
          "logs": [
            {
              "level": "text",
              "message": "text"
            }
          ],
          "remote_id": "text",
          "started": "2025-03-25T04:04:05.785Z",
          "status": "pending"
        }
      ],
      "source": "text",
      "started": "2025-03-25T04:04:05.785Z",
      "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"
    },
    "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-03-25T04:04:05.785Z",
      "state": "pending"
    }
  }'

application/json

200

200

{
  "active": true,
  "autoarchive": true,
  "backend": "csw-dcat",
  "config": {},
  "created_at": "2025-03-25T04:04:05.785Z",
  "deleted": "2025-03-25T04:04:05.785Z",
  "description": "text",
  "id": "text",
  "last_job": {
    "created": "2025-03-25T04:04:05.785Z",
    "ended": "2025-03-25T04:04:05.785Z",
    "errors": [
      {
        "level": "text",
        "message": "text"
      }
    ],
    "id": "text",
    "items": [
      {
        "args": [
          "text"
        ],
        "created": "2025-03-25T04:04:05.785Z",
        "dataservice": {
          "access_type": "open",
          "acronym": "text",
          "archived_at": "2025-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
          "datasets": {},
          "deleted_at": "2025-03-25T04:04:05.785Z",
          "description": "text",
          "extras": {},
          "format": "REST",
          "harvest": {
            "archived_at": "2025-03-25T04:04:05.785Z",
            "archived_reason": "text",
            "backend": "text",
            "created_at": "2025-03-25T04:04:05.785Z",
            "domain": "text",
            "id": "text",
            "last_update": "2025-03-25T04:04:05.785Z",
            "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-03-25T04:04:05.785Z",
          "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-03-25T04:04:05.785Z",
        "errors": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "kwargs": {},
        "logs": [
          {
            "level": "text",
            "message": "text"
          }
        ],
        "remote_id": "text",
        "started": "2025-03-25T04:04:05.785Z",
        "status": "pending"
      }
    ],
    "source": "text",
    "started": "2025-03-25T04:04:05.785Z",
    "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-03-25T04:04:05.785Z",
    "state": "pending"
  }
}

Success