Schedules

Read and set a configuration's run schedule.

Retrieving a schedule

get

This functionality is in preview mode - some of the features may not be fully operational yet.

Retrieves the cron schedule for a configuration.

Required scopes

This endpoint requires the following scopes:

• : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

configIdstring · uuidRequired

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Responses

200

The request was successful. The schedule is returned.

application/json

A cron schedule for a configuration.

idstring · uuidOptional

The schedule identifier.

Example: a3bb189e-8bf9-3888-9912-ace4e6543002

configIdstring · uuidOptional

The scheduled configuration.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

cronstringRequired

A Spring cron expression with six fields.

Example: 0 0 2 * * *

timezonestringOptional

The IANA time zone the cron is evaluated in.

Example: Europe/Berlin

enabledbooleanOptional

Whether the schedule is active.

Example: true

nextFireAtstring · date-timeOptional

The next fire time.

Example: 2026-07-28T00:00:00.000Z

204

No schedule is configured for the configuration.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

get/importtool/{tenant}/configs/{configId}/schedule

GET /importtool/{tenant}/configs/{configId}/schedule HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "cron": "0 0 2 * * *",
  "timezone": "Europe/Berlin",
  "enabled": true,
  "nextFireAt": "2026-07-28T00:00:00.000Z"
}

Scheduling an import job

put

This functionality is in preview mode - some of the features may not be fully operational yet.

Creates or updates the cron schedule (cron expression, time zone, and enabled flag) that runs a configuration automatically.

Required scopes

This endpoint requires the following scopes:

• : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

configIdstring · uuidRequired

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Body

A cron schedule for a configuration.

idstring · uuidOptional

The schedule identifier.

Example: a3bb189e-8bf9-3888-9912-ace4e6543002

configIdstring · uuidOptional

The scheduled configuration.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

cronstringRequired

A Spring cron expression with six fields.

Example: 0 0 2 * * *

timezonestringOptional

The IANA time zone the cron is evaluated in.

Example: Europe/Berlin

enabledbooleanOptional

Whether the schedule is active.

Example: true

nextFireAtstring · date-timeOptional

The next fire time.

Example: 2026-07-28T00:00:00.000Z

Responses

200

The request was successful. The schedule has been saved.

application/json

A cron schedule for a configuration.

idstring · uuidOptional

The schedule identifier.

Example: a3bb189e-8bf9-3888-9912-ace4e6543002

configIdstring · uuidOptional

The scheduled configuration.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

cronstringRequired

A Spring cron expression with six fields.

Example: 0 0 2 * * *

timezonestringOptional

The IANA time zone the cron is evaluated in.

Example: Europe/Berlin

enabledbooleanOptional

Whether the schedule is active.

Example: true

nextFireAtstring · date-timeOptional

The next fire time.

Example: 2026-07-28T00:00:00.000Z

400

The cron expression or timezone value is invalid. The service expects a six-field cron expression (second minute hour day-of-month month day-of-week). A five-field expression such as 0 * * * * is rejected. The service does not store it.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

404

The requested resource does not exist.

application/json

500

Internal Service Error occurred.

application/json

put/importtool/{tenant}/configs/{configId}/schedule

PUT /importtool/{tenant}/configs/{configId}/schedule HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "cron": "0 0 2 * * *",
  "timezone": "Europe/Berlin",
  "enabled": true
}

{
  "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "configId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "cron": "0 0 2 * * *",
  "timezone": "Europe/Berlin",
  "enabled": true,
  "nextFireAt": "2026-07-28T00:00:00.000Z"
}

Removing a schedule

delete

This functionality is in preview mode - some of the features may not be fully operational yet.

Removes the schedule. The configuration then runs only when it is triggered.

The request is idempotent. Removing a schedule that does not exist also returns 204. Unlike creating a schedule, this request does not require the configuration to exist. Use it to remove a schedule that remains after the configuration is deleted.

Required scopes

This endpoint requires the following scopes:

• : Needed to trigger, schedule, monitor, and cancel import runs and to read configurations, streams, schedules, runs, and imported data.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

The tenant you want to access.

Example: mytenant

configIdstring · uuidRequired

The configuration identifier.

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Responses

204

The schedule has been removed. The configuration now runs only when triggered.

No content

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

500

Internal Service Error occurred.

application/json

delete/importtool/{tenant}/configs/{configId}/schedule

DELETE /importtool/{tenant}/configs/{configId}/schedule HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content