harvest
Harvest related operations
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/backends HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"extra_configs": [
{
"default": "text",
"description": "text",
"key": "text",
"label": "text"
}
],
"features": [
{
"default": "text",
"description": "text",
"key": "text",
"label": "text"
}
],
"filters": [
{
"description": "text",
"key": "text",
"label": "text",
"type": "text"
}
],
"id": "text",
"label": "text"
}Paramètres de chemin
identanyRequis
Paramètres de requête
pageintegerOptionnel
The page to fetch
page_sizeintegerOptionnel
The page size to fetch
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/job/{ident}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
activebooleanRequisDefault:
Is this source active
falseautoarchivebooleanRequisDefault:
If enabled, datasets not present on the remote source will be automatically archived
truebackendstring · enumRequisExample:
The source backend
csw-dcatValeurs possibles: configobjectOptionnel
The configuration as key-value pairs
created_atstring · date-timeLecture seuleRequis
The source creation date
deletedstring · date-timeLecture seuleOptionnel
The source deletion date
descriptionstring · markdownOptionnel
The source description
idstringLecture seuleOptionnel
The source unique identifier
last_joball ofLecture seuleOptionnel
The last job for this source
namestringRequis
The source display name
organizationall ofOptionnel
The producer organization
ownerall ofOptionnel
The owner information
schedulestringLecture seuleOptionnel
The source schedule (interval or cron expression)
urlstringRequis
The source base URL
validationall ofLecture seuleOptionnel
Has the source been validated
Réponses
200
Success
application/json
post
POST /api/1/harvest/source/preview HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"description": "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"
},
"url": "text"
}200
Success
{
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"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-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-01T11:26:30.404Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"last_update": "2025-07-01T11:26:30.404Z",
"license": "notspecified",
"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",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-01T11:26:30.404Z",
"start": "2025-07-01T11:26:30.404Z"
},
"title": "text",
"uri": "text"
},
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
activebooleanRequisDefault:
Is this source active
falseautoarchivebooleanRequisDefault:
If enabled, datasets not present on the remote source will be automatically archived
truebackendstring · enumRequisExample:
The source backend
csw-dcatValeurs possibles: configobjectOptionnel
The configuration as key-value pairs
created_atstring · date-timeLecture seuleRequis
The source creation date
deletedstring · date-timeLecture seuleOptionnel
The source deletion date
descriptionstring · markdownOptionnel
The source description
idstringLecture seuleOptionnel
The source unique identifier
last_joball ofLecture seuleOptionnel
The last job for this source
namestringRequis
The source display name
organizationall ofOptionnel
The producer organization
ownerall ofOptionnel
The owner information
schedulestringLecture seuleOptionnel
The source schedule (interval or cron expression)
urlstringRequis
The source base URL
validationall ofLecture seuleOptionnel
Has the source been validated
Réponses
200
Success
application/json
put
PUT /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"description": "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"
},
"url": "text"
}200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}delete
Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
delete
DELETE /api/1/harvest/source/{ident} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Paramètres de chemin
identanyRequis
Paramètres de requête
pageintegerOptionnel
The page to fetch
page_sizeintegerOptionnel
The page size to fetch
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident}/jobs/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"data": [
{
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/source/{ident}/preview HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"badges": [
{
"kind": "text"
}
],
"community_resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
}
}
],
"contact_points": [
{
"contact_form": "text",
"email": "text",
"id": "text",
"name": "text",
"organization": {
"class": "text",
"id": "text",
"acronym": "text",
"badges": [
{
"kind": "text"
}
],
"logo": "text",
"logo_thumbnail": "text",
"name": "text",
"page": "text",
"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-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"featured": true,
"frequency": "unknown",
"frequency_date": "2025-07-01T11:26:30.404Z",
"harvest": {
"archived": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"backend": "text",
"ckan_name": "text",
"ckan_source": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"dct_identifier": "text",
"domain": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"remote_id": "text",
"remote_url": "text",
"source_id": "text",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"last_update": "2025-07-01T11:26:30.404Z",
"license": "notspecified",
"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",
"permissions": {
"delete": true,
"edit": true,
"edit_resources": true
},
"private": true,
"quality": {},
"resources": [
{
"checksum": {
"type": "sha1",
"value": "text"
},
"created_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"filesize": 1,
"filetype": "file",
"format": "text",
"harvest": {
"created_at": "2025-07-01T11:26:30.404Z",
"modified_at": "2025-07-01T11:26:30.404Z",
"uri": "text"
},
"id": "text",
"internal": {
"created_at_internal": "2025-07-01T11:26:30.404Z",
"last_modified_internal": "2025-07-01T11:26:30.404Z"
},
"last_modified": "2025-07-01T11:26:30.404Z",
"latest": "text",
"metrics": {},
"mime": "text",
"preview_url": "text",
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"title": "text",
"type": "main",
"url": "text"
}
],
"schema": {
"name": "text",
"url": "text",
"version": "text"
},
"slug": "text",
"spatial": {
"geom": {
"coordinates": [
{}
],
"type": "Point"
},
"granularity": "other",
"zones": {}
},
"tags": [
"text"
],
"temporal_coverage": {
"end": "2025-07-01T11:26:30.404Z",
"start": "2025-07-01T11:26:30.404Z"
},
"title": "text",
"uri": "text"
},
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
stringOptionnel
Réponses
200
Success
application/json
post
POST /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 6
"text"200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
delete
DELETE /api/1/harvest/source/{ident}/schedule HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Paramètres de chemin
identanyRequis
A source ID or slug
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
byall ofLecture seuleOptionnel
Who performed the validation
commentstringOptionnel
A comment about the validation. Required on rejection
onstring · date-timeLecture seuleOptionnel
Date date on which validation was performed
statestring · enumRequisExample:
Is it validated or not
pendingValeurs possibles: Réponses
200
Success
application/json
post
POST /api/1/harvest/source/{ident}/validate HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"comment": "text",
"state": "pending"
}200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Paramètres de requête
pageintegerOptionnel
The page to fetch
page_sizeintegerOptionnel
The page size to fetch
ownerstringOptionnel
The organization or user ID to filter on
deletedbooleanOptionnel
Include sources flaggued as deleted
qstringOptionnel
The search query
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Réponses
200
Success
application/json
get
GET /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200
Success
[
{
"data": [
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}
],
"next_page": "text",
"page": 1,
"page_size": 1,
"previous_page": "text",
"total": 1
}
]Paramètres d'en-tête
X-Fieldsstring · maskOptionnel
An optional fields mask
Corps
activebooleanRequisDefault:
Is this source active
falseautoarchivebooleanRequisDefault:
If enabled, datasets not present on the remote source will be automatically archived
truebackendstring · enumRequisExample:
The source backend
csw-dcatValeurs possibles: configobjectOptionnel
The configuration as key-value pairs
created_atstring · date-timeLecture seuleRequis
The source creation date
deletedstring · date-timeLecture seuleOptionnel
The source deletion date
descriptionstring · markdownOptionnel
The source description
idstringLecture seuleOptionnel
The source unique identifier
last_joball ofLecture seuleOptionnel
The last job for this source
namestringRequis
The source display name
organizationall ofOptionnel
The producer organization
ownerall ofOptionnel
The owner information
schedulestringLecture seuleOptionnel
The source schedule (interval or cron expression)
urlstringRequis
The source base URL
validationall ofLecture seuleOptionnel
Has the source been validated
Réponses
200
Success
application/json
post
POST /api/1/harvest/sources/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"description": "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"
},
"url": "text"
}200
Success
{
"active": false,
"autoarchive": true,
"backend": "csw-dcat",
"config": {},
"created_at": "2025-07-01T11:26:30.404Z",
"deleted": "2025-07-01T11:26:30.404Z",
"description": "text",
"id": "text",
"last_job": {
"created": "2025-07-01T11:26:30.404Z",
"ended": "2025-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"id": "text",
"items": [
{
"args": [
"text"
],
"created": "2025-07-01T11:26:30.404Z",
"dataservice": {
"access_audiences": [
{
"condition": "yes",
"id": "text",
"role": "local_authority_and_administration"
}
],
"access_type": "open",
"acronym": "text",
"archived_at": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"datasets": {},
"deleted_at": "2025-07-01T11:26:30.404Z",
"description": "text",
"extras": {},
"format": "REST",
"harvest": {
"archived_at": "2025-07-01T11:26:30.404Z",
"archived_reason": "text",
"backend": "text",
"created_at": "2025-07-01T11:26:30.404Z",
"domain": "text",
"id": "text",
"last_update": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"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"
},
"permissions": {
"delete": true,
"edit": true
},
"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-07-01T11:26:30.404Z",
"errors": [
{
"level": "text",
"message": "text"
}
],
"kwargs": {},
"logs": [
{
"level": "text",
"message": "text"
}
],
"remote_id": "text",
"started": "2025-07-01T11:26:30.404Z",
"status": "pending"
}
],
"source": "text",
"started": "2025-07-01T11:26:30.404Z",
"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-07-01T11:26:30.404Z",
"state": "pending"
}
}Dernière mise à jour
Cet article vous a-t-il été utile ?