Last updated: July 22, 2025

DQOps REST API defaults operations

Default settings management for configuring the default data quality checks that are configured for all imported tables and columns.

---

get_default_schedule

Returns spec to show and edit the default configuration of schedules.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/defaults/defaultschedule/{schedulingGroup}

Return value

Property name	Description	Data type
cron_schedule_spec		CronScheduleSpec

Parameters of this method are described below

Property name	Description	Data type	Required
scheduling_group	Check scheduling group (named schedule)	CheckRunScheduleGroup

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/defaults/defaultschedule/partitioned_daily^
    -H "Accept: application/json"

Expand to see the returned result

{
  "cron_expression" : "0 12 1 * *"
}

Execution

from dqops import client
from dqops.client.api.defaults import get_default_schedule
from dqops.client.models import CheckRunScheduleGroup

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_default_schedule.sync(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client
)

Expand to see the returned result

CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_schedule
from dqops.client.models import CheckRunScheduleGroup

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_default_schedule.asyncio(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client
)

Expand to see the returned result

CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_schedule
from dqops.client.models import CheckRunScheduleGroup

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_default_schedule.sync(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client
)

Expand to see the returned result

CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_schedule
from dqops.client.models import CheckRunScheduleGroup

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_default_schedule.asyncio(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client
)

Expand to see the returned result

CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

---

get_default_webhooks

Returns spec to show and edit the default configuration of addresses for incident notifications.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/defaults/defaultwebhooks

Return value

Property name	Description	Data type
incident_notification_spec		IncidentNotificationSpec

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/defaults/defaultwebhooks^
    -H "Accept: application/json"

Expand to see the returned result

{
  "incident_opened_addresses" : "https://sample_url.com/opened",
  "incident_acknowledged_addresses" : "https://sample_url.com/acknowledged",
  "incident_resolved_addresses" : "https://sample_url.com/resolved",
  "incident_muted_addresses" : "https://sample_url.com/muted"
}

Execution

from dqops import client
from dqops.client.api.defaults import get_default_webhooks

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_default_webhooks.sync(
    client=dqops_client
)

Expand to see the returned result

IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_webhooks

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_default_webhooks.asyncio(
    client=dqops_client
)

Expand to see the returned result

IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_webhooks

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_default_webhooks.sync(
    client=dqops_client
)

Expand to see the returned result

IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

Execution

from dqops import client
from dqops.client.api.defaults import get_default_webhooks

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_default_webhooks.asyncio(
    client=dqops_client
)

Expand to see the returned result

IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

---

update_default_schedules

New configuration of the default schedules.

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/defaults/defaultschedule/{schedulingGroup}

Parameters of this method are described below

Property name	Description	Data type	Required
scheduling_group	Check scheduling group (named schedule)	CheckRunScheduleGroup

Request body

Description	Data type	Required
Spec with default schedules changes to be applied to the default configuration.	CronScheduleSpec

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X PUT http://localhost:8888/api/defaults/defaultschedule/partitioned_daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"cron_expression\":\"0 12 1 * *\"}"

Execution

from dqops import client
from dqops.client.api.defaults import update_default_schedules
from dqops.client.models import CheckRunScheduleGroup, \
                                CronScheduleSpec

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

call_result = update_default_schedules.sync(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_schedules
from dqops.client.models import CheckRunScheduleGroup, \
                                CronScheduleSpec

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

call_result = await update_default_schedules.asyncio(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_schedules
from dqops.client.models import CheckRunScheduleGroup, \
                                CronScheduleSpec

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

call_result = update_default_schedules.sync(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_schedules
from dqops.client.models import CheckRunScheduleGroup, \
                                CronScheduleSpec

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = CronScheduleSpec(
    cron_expression='0 12 1 * *',
    disabled=False
)

call_result = await update_default_schedules.asyncio(
    CheckRunScheduleGroup.partitioned_daily,
    client=dqops_client,
    json_body=request_body
)

---

update_default_webhooks

New configuration of the default addresses.

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/defaults/defaultwebhooks

Request body

Description	Data type	Required
Spec with default notification addresses changes to be applied to the default configuration	IncidentNotificationSpec

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X PUT http://localhost:8888/api/defaults/defaultwebhooks^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"incident_opened_addresses\":\"https://sample_url.com/opened\",\"incident_acknowledged_addresses\":\"https://sample_url.com/acknowledged\",\"incident_resolved_addresses\":\"https://sample_url.com/resolved\",\"incident_muted_addresses\":\"https://sample_url.com/muted\"}"

Execution

from dqops import client
from dqops.client.api.defaults import update_default_webhooks
from dqops.client.models import FilteredNotificationSpecMap, \
                                IncidentNotificationSpec

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

call_result = update_default_webhooks.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_webhooks
from dqops.client.models import FilteredNotificationSpecMap, \
                                IncidentNotificationSpec

dqops_client = client.Client(
    'http://localhost:8888/'
)

request_body = IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

call_result = await update_default_webhooks.asyncio(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_webhooks
from dqops.client.models import FilteredNotificationSpecMap, \
                                IncidentNotificationSpec

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

call_result = update_default_webhooks.sync(
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.defaults import update_default_webhooks
from dqops.client.models import FilteredNotificationSpecMap, \
                                IncidentNotificationSpec

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token
)

request_body = IncidentNotificationSpec(
    incident_opened_addresses='https://sample_url.com/opened',
    incident_acknowledged_addresses='https://sample_url.com/acknowledged',
    incident_resolved_addresses='https://sample_url.com/resolved',
    incident_muted_addresses='https://sample_url.com/muted',
    filtered_notifications=FilteredNotificationSpecMap()
)

call_result = await update_default_webhooks.asyncio(
    client=dqops_client,
    json_body=request_body
)