datasets

Dataset related operations

Dernière mise à jour il y a 1 an

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

List all available dataset badges and their labels

get

Responses

get

GET /api/1/datasets/badges/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

List all community resources

get

Query parameters

sortanyoptional

The sorting attribute

pageanyoptional

The page to fetch

page_sizeanyoptional

The page size to fetch

organizationanyoptional

Filter activities for that particular organization

datasetanyoptional

Filter activities for that particular dataset

owneranyoptional

Filter activities for that particular user

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

GET /api/1/datasets/community_resources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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"
      }
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Retrieve a community resource given its identifier

get

Path parameters

communityanyrequired

The community resource unique identifier

Query parameters

datasetanyoptional

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

all ofoptional

get

GET /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "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"
  }
}

Delete a given community resource

delete

Path parameters

communityanyrequired

The community resource unique identifier

Query parameters

datasetanyoptional

The dataset ID or slug

Responses

delete

DELETE /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Update the file related to a given community resource

post

Path parameters

communityanyrequired

The community resource unique identifier

Query parameters

datasetanyoptional

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

all ofoptional

post

POST /api/1/datasets/community_resources/{community}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "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"
  },
  "success": true
}

List all allowed resources extensions

get

Responses

application/json

string[]optional

get

GET /api/1/datasets/extensions/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  "text"
]

List all available frequencies

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

GET /api/1/datasets/frequencies/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "id": "text",
    "label": "text"
  }
]

List all available licenses

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

GET /api/1/datasets/licenses/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "alternate_titles": [
      "text"
    ],
    "alternate_urls": [
      "text"
    ],
    "flags": [
      "text"
    ],
    "id": "text",
    "maintainer": "text",
    "title": "text",
    "url": "text"
  }
]

Redirect to the latest version of a resource given its identifier

get

Path parameters

idanyrequired

Query parameters

datasetanyoptional

The dataset ID or slug

Responses

get

GET /api/1/datasets/r/{id} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

List all resource types

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

GET /api/1/datasets/resource_types/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "id": "text",
    "label": "text"
  }
]

List all available schemas

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

GET /api/1/datasets/schemas/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  {
    "consolidation_dataset_id": "text",
    "contact": "text",
    "datapackage_description": "text",
    "datapackage_name": "text",
    "datapackage_title": "text",
    "description": "text",
    "examples": [
      {
        "path": "text",
        "title": "text"
      }
    ],
    "external_doc": "text",
    "external_tool": "text",
    "homepage": "text",
    "labels": [
      "text"
    ],
    "name": "text",
    "schema_type": "tableschema",
    "schema_url": "text",
    "title": "text",
    "versions": [
      {
        "schema_url": "text",
        "version_name": "text"
      }
    ]
  }
]

Datasets suggest endpoint using mongoDB contains

get

Query parameters

qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

GET /api/1/datasets/suggest/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "acronym": "text",
  "id": "text",
  "image_url": "text",
  "page": "text",
  "slug": "text",
  "title": "text"
}

Suggest file formats

get

Query parameters

qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Responses

get

GET /api/1/datasets/suggest/formats/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Suggest mime types

get

Query parameters

qanyrequired

The string to autocomplete/suggest

sizeanyoptional

The amount of suggestion to fetch

Responses

get

GET /api/1/datasets/suggest/mime/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Get a dataset given its identifier

get

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

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

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
  "deleted": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-04-15T08:07:47.524Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-04-15T08:07:47.524Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "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-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

Delete a dataset given its identifier

delete

Path parameters

datasetanyrequired

The dataset ID or slug

Responses

delete

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

No Content

Delete a badge for a given dataset

delete

Path parameters

badge_kindanyrequired

datasetanyrequired

The dataset ID or slug

Responses

delete

DELETE /api/1/datasets/{dataset}/badges/{badge_kind}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Mark the dataset as featured

post

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

post

POST /api/1/datasets/{dataset}/featured/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
  "deleted": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-04-15T08:07:47.524Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-04-15T08:07:47.524Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "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-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

Unmark the dataset as featured

delete

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

delete

DELETE /api/1/datasets/{dataset}/featured/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
  "deleted": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-04-15T08:07:47.524Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-04-15T08:07:47.524Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "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-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

get

Path parameters

datasetanyrequired

The dataset ID or slug

Responses

get

GET /api/1/datasets/{dataset}/rdf HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

No Content

get

Path parameters

datasetanyrequired

The dataset ID or slug

formatanyrequired

Responses

get

GET /api/1/datasets/{dataset}/rdf.{format} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

No Content

Get a resource given its identifier

get

Path parameters

ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

GET /api/1/datasets/{dataset}/resources/{rid}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Delete a given resource on a given dataset

delete

Path parameters

ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Responses

delete

DELETE /api/1/datasets/{dataset}/resources/{rid}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Checks that a resource's URL exists and returns metadata

get

Path parameters

ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Responses

get

GET /api/1/datasets/{dataset}/resources/{rid}/check/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Upload a file related to a given resource on a given dataset

post

Path parameters

ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

all ofoptional

post

POST /api/1/datasets/{dataset}/resources/{rid}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "success": true
}

List all followers for a given object

get

Path parameters

idanyrequired

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

objectoptional

get

GET /api/1/datasets/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2025-04-15T08:07:47.524Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Follow an object given its ID

post

Returns the number of followers left after the operation

Path parameters

idanyrequired

Responses

post

POST /api/1/datasets/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Path parameters

idanyrequired

Responses

delete

DELETE /api/1/datasets/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

No Content

List or search all datasets

get

Query parameters

qanyoptional

The search query

sortanyoptional

The field (and direction) on which sorting apply

pageanyoptional

The page to display

page_sizeanyoptional

The page size

taganyoptional

licenseanyoptional

featuredanyoptional

geozoneanyoptional

granularityanyoptional

temporal_coverageanyoptional

organizationanyoptional

organization_badgeanyoptional

owneranyoptional

formatanyoptional

schemaanyoptional

schema_versionanyoptional

topicanyoptional

creditanyoptional

dataserviceanyoptional

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

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

200

Success

{
  "data": [
    {
      "acronym": "text",
      "archived": "2025-04-15T08:07:47.524Z",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "community_resources": [
        {
          "checksum": {
            "type": "sha1",
            "value": "text"
          },
          "created_at": "2025-04-15T08:07:47.524Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-04-15T08:07:47.524Z",
            "modified_at": "2025-04-15T08:07:47.524Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-04-15T08:07:47.524Z",
            "last_modified_internal": "2025-04-15T08:07:47.524Z"
          },
          "last_modified": "2025-04-15T08:07:47.524Z",
          "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-04-15T08:07:47.524Z",
      "deleted": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "featured": true,
      "frequency": "unknown",
      "frequency_date": "2025-04-15T08:07:47.524Z",
      "harvest": {
        "archived": "text",
        "archived_at": "2025-04-15T08:07:47.524Z",
        "backend": "text",
        "ckan_name": "text",
        "ckan_source": "text",
        "created_at": "2025-04-15T08:07:47.524Z",
        "dct_identifier": "text",
        "domain": "text",
        "last_update": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "remote_id": "text",
        "remote_url": "text",
        "source_id": "text",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "last_update": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
          "description": "text",
          "extras": {},
          "filesize": 1,
          "filetype": "file",
          "format": "text",
          "harvest": {
            "created_at": "2025-04-15T08:07:47.524Z",
            "modified_at": "2025-04-15T08:07:47.524Z",
            "uri": "text"
          },
          "id": "text",
          "internal": {
            "created_at_internal": "2025-04-15T08:07:47.524Z",
            "last_modified_internal": "2025-04-15T08:07:47.524Z"
          },
          "last_modified": "2025-04-15T08:07:47.524Z",
          "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-04-15T08:07:47.524Z",
        "start": "2025-04-15T08:07:47.524Z"
      },
      "title": "text",
      "uri": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Create a new dataset

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

acronymstringoptional

An optional dataset acronym

archivedstring · date-timeoptional

The archival date if archived

badgesobject[]read-onlyoptional

The dataset badges

community_resourcesall of[]optional

The dataset community submitted resources

contact_pointsall of[]optional

The dataset contact points

created_atstring · date-timeread-onlyrequired

This date is computed between harvested creation date if any and site's internal creation date

deletedstring · date-timeread-onlyoptional

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobjectoptional

Extras attributes as key-value pairs

featuredbooleanoptional

Is the dataset featured

frequencystring · enumrequired

The update frequency

Default: unknownExample: unknownAvailable options:

frequency_datestring · date-timeoptional

Next expected update date, you will be notified once that date is reached.

harvestall ofread-onlyoptional

Dataset harvest metadata attributes

idstringread-onlyoptional

The dataset identifier

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyrequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestringoptional

The dataset license

Default: notspecified

metricsobjectoptional

The dataset metrics

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

pagestringrequired

The dataset page URL

privatebooleanoptional

Is the dataset private to the owner or the organization

qualityobjectread-onlyoptional

The dataset quality

resourcesall of[]optional

The dataset resources

schemaall ofoptional

Reference to the associated schema

slugstringrequired

The dataset permalink string

spatialall ofoptional

The spatial coverage

tagsstring[]optional

temporal_coverageall ofoptional

The temporal coverage

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

Responses

application/json

objectoptional

post

POST /api/1/datasets/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 1857

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "mime": "text",
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "title": "text",
      "type": "main",
      "url": "text",
      "dataset": {
        "class": "text",
        "id": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "slug": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "slug": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "license": "text",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "page": "text",
  "private": true,
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "mime": "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
  "deleted": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-04-15T08:07:47.524Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-04-15T08:07:47.524Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "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-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

Create a new community resource

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

all ofoptional

Responses

application/json

all ofoptional

post

POST /api/1/datasets/community_resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 492

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "mime": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "dataset": {
    "class": "text",
    "id": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  }
}

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "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"
  }
}

Update a given community resource

put

Path parameters

communityanyrequired

The community resource unique identifier

Query parameters

datasetanyoptional

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

all ofoptional

Responses

application/json

all ofoptional

put

PUT /api/1/datasets/community_resources/{community}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 492

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "mime": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "dataset": {
    "class": "text",
    "id": "text"
  },
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  }
}

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "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"
  }
}

Update a dataset given its identifier

put

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

acronymstringoptional

An optional dataset acronym

archivedstring · date-timeoptional

The archival date if archived

badgesobject[]read-onlyoptional

The dataset badges

community_resourcesall of[]optional

The dataset community submitted resources

contact_pointsall of[]optional

The dataset contact points

created_atstring · date-timeread-onlyrequired

This date is computed between harvested creation date if any and site's internal creation date

deletedstring · date-timeread-onlyoptional

The deletion date if deleted

descriptionstring · markdownrequired

The dataset description in markdown

extrasobjectoptional

Extras attributes as key-value pairs

featuredbooleanoptional

Is the dataset featured

frequencystring · enumrequired

The update frequency

Default: unknownExample: unknownAvailable options:

frequency_datestring · date-timeoptional

Next expected update date, you will be notified once that date is reached.

harvestall ofread-onlyoptional

Dataset harvest metadata attributes

idstringread-onlyoptional

The dataset identifier

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyrequired

The dataset last modification date

last_updatestring · date-timerequired

The resources last modification date

licensestringoptional

The dataset license

Default: notspecified

metricsobjectoptional

The dataset metrics

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

pagestringrequired

The dataset page URL

privatebooleanoptional

Is the dataset private to the owner or the organization

qualityobjectread-onlyoptional

The dataset quality

resourcesall of[]optional

The dataset resources

schemaall ofoptional

Reference to the associated schema

slugstringrequired

The dataset permalink string

spatialall ofoptional

The spatial coverage

tagsstring[]optional

temporal_coverageall ofoptional

The temporal coverage

titlestringrequired

The dataset title

uristringrequired

The dataset API URI

Responses

application/json

objectoptional

put

PUT /api/1/datasets/{dataset}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 1857

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "mime": "text",
      "schema": {
        "name": "text",
        "url": "text",
        "version": "text"
      },
      "title": "text",
      "type": "main",
      "url": "text",
      "dataset": {
        "class": "text",
        "id": "text"
      },
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "slug": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      }
    }
  ],
  "contact_points": [
    {
      "contact_form": "text",
      "email": "text",
      "name": "text",
      "organization": {
        "class": "text",
        "id": "text",
        "acronym": "text",
        "logo": "text",
        "logo_thumbnail": "text",
        "slug": "text"
      },
      "owner": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "slug": "text",
        "uri": "text"
      },
      "role": "text"
    }
  ],
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "license": "text",
  "metrics": {},
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "page": "text",
  "private": true,
  "resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "mime": "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

{
  "acronym": "text",
  "archived": "2025-04-15T08:07:47.524Z",
  "badges": [
    {
      "kind": "text"
    }
  ],
  "community_resources": [
    {
      "checksum": {
        "type": "sha1",
        "value": "text"
      },
      "created_at": "2025-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
  "deleted": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "featured": true,
  "frequency": "unknown",
  "frequency_date": "2025-04-15T08:07:47.524Z",
  "harvest": {
    "archived": "text",
    "archived_at": "2025-04-15T08:07:47.524Z",
    "backend": "text",
    "ckan_name": "text",
    "ckan_source": "text",
    "created_at": "2025-04-15T08:07:47.524Z",
    "dct_identifier": "text",
    "domain": "text",
    "last_update": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "remote_id": "text",
    "remote_url": "text",
    "source_id": "text",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "last_update": "2025-04-15T08:07:47.524Z",
  "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-04-15T08:07:47.524Z",
      "description": "text",
      "extras": {},
      "filesize": 1,
      "filetype": "file",
      "format": "text",
      "harvest": {
        "created_at": "2025-04-15T08:07:47.524Z",
        "modified_at": "2025-04-15T08:07:47.524Z",
        "uri": "text"
      },
      "id": "text",
      "internal": {
        "created_at_internal": "2025-04-15T08:07:47.524Z",
        "last_modified_internal": "2025-04-15T08:07:47.524Z"
      },
      "last_modified": "2025-04-15T08:07:47.524Z",
      "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-04-15T08:07:47.524Z",
    "start": "2025-04-15T08:07:47.524Z"
  },
  "title": "text",
  "uri": "text"
}

Create a new badge for a given dataset

post

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

kindstringrequired

Kind of badge (certified, etc), specific to each model

Responses

application/json

objectoptional

post

POST /api/1/datasets/{dataset}/badges/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "kind": "text"
}

200

Success

{
  "kind": "text"
}

Create a new resource for a given dataset

post

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: fileAvailable options:

formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: mainAvailable options:

urlstringrequired

The resource URL

Responses

application/json

objectoptional

post

POST /api/1/datasets/{dataset}/resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "mime": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Reorder resources

put

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: fileAvailable options:

formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: mainAvailable options:

urlstringrequired

The resource URL

Responses

application/json

object[]optional

put

PUT /api/1/datasets/{dataset}/resources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 236

[
  {
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "mime": "text",
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    },
    "title": "text",
    "type": "main",
    "url": "text"
  }
]

[
  {
    "checksum": {
      "type": "sha1",
      "value": "text"
    },
    "created_at": "2025-04-15T08:07:47.524Z",
    "description": "text",
    "extras": {},
    "filesize": 1,
    "filetype": "file",
    "format": "text",
    "harvest": {
      "created_at": "2025-04-15T08:07:47.524Z",
      "modified_at": "2025-04-15T08:07:47.524Z",
      "uri": "text"
    },
    "id": "text",
    "internal": {
      "created_at_internal": "2025-04-15T08:07:47.524Z",
      "last_modified_internal": "2025-04-15T08:07:47.524Z"
    },
    "last_modified": "2025-04-15T08:07:47.524Z",
    "latest": "text",
    "metrics": {},
    "mime": "text",
    "preview_url": "text",
    "schema": {
      "name": "text",
      "url": "text",
      "version": "text"
    },
    "title": "text",
    "type": "main",
    "url": "text"
  }
]

Update a given resource on a given dataset

put

Path parameters

ridanyrequired

The resource unique identifier

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

checksumall ofoptional

A checksum to validate file validity

created_atstring · date-timeread-onlyoptional

The resource creation date

descriptionstring · markdownoptional

The resource markdown description

extrasobjectoptional

Extra attributes as key-value pairs

filesizeintegeroptional

The resource file size in bytes

filetypestring · enumrequired

Whether the resource is an uploaded file, a remote file or an API

Example: fileAvailable options:

formatstringrequired

The resource format

harvestall ofread-onlyoptional

Harvest attributes metadata information

idstringread-onlyoptional

The resource unique ID

internalall ofread-onlyoptional

Site internal and specific object's data

last_modifiedstring · date-timeread-onlyoptional

The resource last modification date

lateststringread-onlyoptional

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metricsobjectread-onlyoptional

The resource metrics

mimestringoptional

The resource mime type

preview_urlstringread-onlyoptional

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

schemaall ofoptional

Reference to the associated schema

titlestringrequired

The resource title

typestring · enumrequired

Resource type (documentation, API...)

Example: mainAvailable options:

urlstringrequired

The resource URL

Responses

application/json

objectoptional

put

PUT /api/1/datasets/{dataset}/resources/{rid}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "mime": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text"
}

Upload a file for a new dataset resource

post

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

filefileoptional

uuidstringoptional

filenamestringoptional

partindexintegeroptional

partbyteoffsetintegeroptional

totalpartsintegeroptional

chunksizeintegeroptional

Responses

application/json

all ofoptional

post

POST /api/1/datasets/{dataset}/upload/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 107

"file=null&uuid='text'&filename='text'&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1"

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "latest": "text",
  "metrics": {},
  "mime": "text",
  "preview_url": "text",
  "schema": {
    "name": "text",
    "url": "text",
    "version": "text"
  },
  "title": "text",
  "type": "main",
  "url": "text",
  "success": true
}

Upload a new community resource

post

Path parameters

datasetanyrequired

The dataset ID or slug

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

filefileoptional

uuidstringoptional

filenamestringoptional

partindexintegeroptional

partbyteoffsetintegeroptional

totalpartsintegeroptional

chunksizeintegeroptional

Responses

application/json

all ofoptional

post

POST /api/1/datasets/{dataset}/upload/community/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 107

"file=null&uuid='text'&filename='text'&partindex=1&partbyteoffset=1&totalparts=1&chunksize=1"

{
  "checksum": {
    "type": "sha1",
    "value": "text"
  },
  "created_at": "2025-04-15T08:07:47.524Z",
  "description": "text",
  "extras": {},
  "filesize": 1,
  "filetype": "file",
  "format": "text",
  "harvest": {
    "created_at": "2025-04-15T08:07:47.524Z",
    "modified_at": "2025-04-15T08:07:47.524Z",
    "uri": "text"
  },
  "id": "text",
  "internal": {
    "created_at_internal": "2025-04-15T08:07:47.524Z",
    "last_modified_internal": "2025-04-15T08:07:47.524Z"
  },
  "last_modified": "2025-04-15T08:07:47.524Z",
  "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"
  },
  "success": true
}