workers

Asynchronous workers related operations

List all scheduled jobs

get

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

object[]optional

get

HTTPcURLJavaScriptPython

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

200

Success

[
  {
    "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-04-15T08:09:38.027Z",
    "last_run_id": "text",
    "name": "text",
    "schedule": "text",
    "task": "test-high-queue"
  }
]

Create a new scheduled job

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

argsobject[]optional

The job execution arguments

Default: []

crontabobjectoptional

descriptionstringoptional

The job description

enabledbooleanoptional

Is this job enabled

Default: false

idstringread-onlyoptional

The job unique identifier

intervalobjectoptional

kwargsobjectoptional

The job execution keyword arguments

Default: {}

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-queueAvailable options:

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

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

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

200

Success

{
  "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-04-15T08:09:38.027Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

List all schedulable jobs

get

Responses

application/json

string[]optional

get

HTTPcURLJavaScriptPython

GET /api/1/workers/jobs/schedulables HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

[
  "text"
]

Fetch a single scheduled job

get

Path parameters

idanyrequired

A job ID

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

200

Success

{
  "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-04-15T08:09:38.027Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

Update a single scheduled job

put

Path parameters

idanyrequired

A job ID

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

put

HTTPcURLJavaScriptPython

PUT /api/1/workers/jobs/{id} HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

200

Success

{
  "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-04-15T08:09:38.027Z",
  "last_run_id": "text",
  "name": "text",
  "schedule": "text",
  "task": "test-high-queue"
}

Delete a single scheduled job

delete

Path parameters

idanyrequired

A job ID

Responses

delete

HTTPcURLJavaScriptPython

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

204

Successfuly deleted

No Content

Get a tasks status given its ID

get

Path parameters

idanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

200

Success

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