workers

Asynchronous workers related operations

List all scheduled jobs

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "args": [
      {}
    ],
    "crontab": {
      "day_of_month": "text",
      "day_of_week": "text",
      "hour": "text",
      "minute": "text",
      "month_of_year": "text"
    },
    "description": "text",
    "enabled": true,
    "id": "text",
    "interval": {
      "every": 1,
      "period": "days"
    },
    "kwargs": {},
    "last_run_at": "2025-03-22T01:49:11.266Z",
    "last_run_id": "text",
    "name": "text",
    "schedule": "text",
    "task": "test-high-queue"
  }
]

Success

Create a new scheduled job

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

argsobject[] · default: []optional

The job execution arguments

crontabobjectoptional

descriptionstringoptional

The job description

enabledboolean · default: falseoptional

Is this job enabled

idstringread-onlyoptional

The job unique identifier

intervalobjectoptional

kwargsobject · default: {}optional

The job execution keyword arguments

last_run_atstring · date-timeread-onlyoptional

The last job execution date

last_run_idstringread-onlyoptional

The last execution task id

namestringrequired

The job unique name

schedulestringread-onlyoptional

The schedule display

taskstring · enumrequired

The task name

Example: test-high-queue

Options: test-high-queue, test-default-queue, purge-harvesters, harvest, check-integrity, export-csv, update-metrics, purge-datasets, purge-harvest-jobs, notify-inactive-users, bind-tabular-dataservice, compute-site-metrics, send-frequency-reminder, delete-inactive-users, test-error, compute-geozones-metrics, count-tags, piwik-bulk-track-api, update-datasets-reuses-metrics, test-log, purge-reuses, map-transport-datasets, purge-chunks, test-low-queue, recommendations-clean, purge-organizations, recommendations-add

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/workers/jobs/' \
  --header 'Content-Type: application/json' \
  --data '{
    "args": [
      {}
    ],
    "crontab": {
      "day_of_month": "text",
      "day_of_week": "text",
      "hour": "text",
      "minute": "text",
      "month_of_year": "text"
    },
    "description": "text",
    "enabled": true,
    "interval": {
      "every": 1,
      "period": "days"
    },
    "kwargs": {},
    "name": "text",
    "task": "test-high-queue"
  }'

application/json

200

200

{
  "args": [
    {}
  ],
  "crontab": {
    "day_of_month": "text",
    "day_of_week": "text",
    "hour": "text",
    "minute": "text",
    "month_of_year": "text"
  },
  "description": "text",
  "enabled": true,
  "id": "text",
  "interval": {
    "every": 1,
    "period": "days"
  },
  "kwargs": {},
  "last_run_at": "2025-03-22T01:49:11.266Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

Success

List all schedulable jobs

get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/workers/jobs/schedulables'

200

200

[
  "text"
]

Success

Fetch a single scheduled job

get

Path parameters

idanyrequired

A job ID

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/workers/jobs/{id}'

200

200

{
  "args": [
    {}
  ],
  "crontab": {
    "day_of_month": "text",
    "day_of_week": "text",
    "hour": "text",
    "minute": "text",
    "month_of_year": "text"
  },
  "description": "text",
  "enabled": true,
  "id": "text",
  "interval": {
    "every": 1,
    "period": "days"
  },
  "kwargs": {},
  "last_run_at": "2025-03-22T01:49:11.266Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

Success

Update a single scheduled job

put

Path parameters

idanyrequired

A job ID

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/workers/jobs/{id}'

200

200

{
  "args": [
    {}
  ],
  "crontab": {
    "day_of_month": "text",
    "day_of_week": "text",
    "hour": "text",
    "minute": "text",
    "month_of_year": "text"
  },
  "description": "text",
  "enabled": true,
  "id": "text",
  "interval": {
    "every": 1,
    "period": "days"
  },
  "kwargs": {},
  "last_run_at": "2025-03-22T01:49:11.266Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

Success

Delete a single scheduled job

delete

Path parameters

idanyrequired

A job ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/workers/jobs/{id}'

204

204

No body

Successfuly deleted

Get a tasks status given its ID

get

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/workers/tasks/{id}'

200

200

{
  "exc": "text",
  "id": "text",
  "result": "text",
  "status": "PENDING",
  "traceback": "text"
}

Success