Last updated: July 22, 2025

DQOps REST API checks operations

Data quality check definition management operations for adding/removing/changing custom data quality checks.

---

create_check

Creates (adds) a new custom check that is a pair of a sensor name and a rule name.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/checks/{fullCheckName}

Parameters of this method are described below

Property name	Description	Data type	Required
full_check_name	Full check name	string

Request body

Description	Data type	Required
Check model	CheckDefinitionModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X POST http://localhost:8888/api/checks/sample_target/sample_category/sample_check^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"check_name\":\"sample_check\",\"sensor_name\":\"sample_target/sample_category/table/volume/row_count\",\"rule_name\":\"sample_target/sample_category/sample_rule\",\"help_text\":\"Sample help text\",\"standard\":false,\"default_severity\":\"error\",\"custom\":true,\"built_in\":false,\"can_edit\":true}"

Execution

from dqops import client
from dqops.client.api.checks import create_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = create_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import create_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = await create_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import create_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

token = 's4mp13_4u7h_70k3n'

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = create_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import create_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

token = 's4mp13_4u7h_70k3n'

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = await create_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

---

delete_check

Deletes a custom check definition

Follow the link to see the source code on GitHub.

DELETE

http://localhost:8888/api/checks/{fullCheckName}

Parameters of this method are described below

Property name	Description	Data type	Required
full_check_name	Full check name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X DELETE http://localhost:8888/api/checks/sample_target/sample_category/sample_check^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.checks import delete_check

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

call_result = delete_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.checks import delete_check

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

call_result = await delete_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.checks import delete_check

token = 's4mp13_4u7h_70k3n'

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

call_result = delete_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.checks import delete_check

token = 's4mp13_4u7h_70k3n'

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

call_result = await delete_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

---

get_all_checks

Returns a flat list of all checks available in DQOps, both built-in checks and user defined or customized checks.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/checks

Return value

Property name	Description	Data type
check_definition_list_model		List[CheckDefinitionListModel]

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "check_name" : "sample_check",
  "full_check_name" : "sample_target/sample_category/sample_check",
  "custom" : false,
  "built_in" : false,
  "can_edit" : true
}, {
  "check_name" : "sample_check",
  "full_check_name" : "sample_target/sample_category/sample_check",
  "custom" : false,
  "built_in" : false,
  "can_edit" : true
}, {
  "check_name" : "sample_check",
  "full_check_name" : "sample_target/sample_category/sample_check",
  "custom" : false,
  "built_in" : false,
  "can_edit" : true
} ]

Execution

from dqops import client
from dqops.client.api.checks import get_all_checks

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

call_result = get_all_checks.sync(
    client=dqops_client
)

Expand to see the returned result

[
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    )
]

Execution

from dqops import client
from dqops.client.api.checks import get_all_checks

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

call_result = await get_all_checks.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    )
]

Execution

from dqops import client
from dqops.client.api.checks import get_all_checks

token = 's4mp13_4u7h_70k3n'

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

call_result = get_all_checks.sync(
    client=dqops_client
)

Expand to see the returned result

[
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    )
]

Execution

from dqops import client
from dqops.client.api.checks import get_all_checks

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_all_checks.asyncio(
    client=dqops_client
)

Expand to see the returned result

[
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    ),
    CheckDefinitionListModel(
        check_name='sample_check',
        full_check_name='sample_target/sample_category/sample_check',
        custom=False,
        built_in=False,
        can_edit=True
    )
]

---

get_check

Returns a check definition

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/checks/{fullCheckName}

Return value

Property name	Description	Data type
check_definition_model		CheckDefinitionModel

Parameters of this method are described below

Property name	Description	Data type	Required
full_check_name	Full check name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/checks/sample_target/sample_category/sample_check^
    -H "Accept: application/json"

Expand to see the returned result

{
  "check_name" : "sample_check",
  "sensor_name" : "sample_target/sample_category/table/volume/row_count",
  "rule_name" : "sample_target/sample_category/sample_rule",
  "help_text" : "Sample help text",
  "standard" : false,
  "default_severity" : "error",
  "custom" : true,
  "built_in" : false,
  "can_edit" : true
}

Execution

from dqops import client
from dqops.client.api.checks import get_check

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

call_result = get_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

Execution

from dqops import client
from dqops.client.api.checks import get_check

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

call_result = await get_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

Execution

from dqops import client
from dqops.client.api.checks import get_check

token = 's4mp13_4u7h_70k3n'

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

call_result = get_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

Execution

from dqops import client
from dqops.client.api.checks import get_check

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

---

get_check_folder_tree

Returns a tree of all checks available in DQOps, both built-in checks and user defined or customized checks.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/definitions/checks

Return value

Property name	Description	Data type
check_definition_folder_model		CheckDefinitionFolderModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/definitions/checks^
    -H "Accept: application/json"

Expand to see the returned result

{ }

Execution

from dqops import client
from dqops.client.api.checks import get_check_folder_tree

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

call_result = get_check_folder_tree.sync(
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionFolderModel(
    folders={

    }
)

Execution

from dqops import client
from dqops.client.api.checks import get_check_folder_tree

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

call_result = await get_check_folder_tree.asyncio(
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionFolderModel(
    folders={

    }
)

Execution

from dqops import client
from dqops.client.api.checks import get_check_folder_tree

token = 's4mp13_4u7h_70k3n'

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

call_result = get_check_folder_tree.sync(
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionFolderModel(
    folders={

    }
)

Execution

from dqops import client
from dqops.client.api.checks import get_check_folder_tree

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_check_folder_tree.asyncio(
    client=dqops_client
)

Expand to see the returned result

CheckDefinitionFolderModel(
    folders={

    }
)

---

update_check

Updates an existing check, making a custom check definition if it is not present

Follow the link to see the source code on GitHub.

PUT

http://localhost:8888/api/checks/{fullCheckName}

Parameters of this method are described below

Property name	Description	Data type	Required
full_check_name	Full check name	string

Request body

Description	Data type	Required
List of check definitions	CheckDefinitionModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl -X PUT http://localhost:8888/api/checks/sample_target/sample_category/sample_check^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"check_name\":\"sample_check\",\"sensor_name\":\"sample_target/sample_category/table/volume/row_count\",\"rule_name\":\"sample_target/sample_category/sample_rule\",\"help_text\":\"Sample help text\",\"standard\":false,\"default_severity\":\"error\",\"custom\":true,\"built_in\":false,\"can_edit\":true}"

Execution

from dqops import client
from dqops.client.api.checks import update_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = update_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import update_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = await update_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import update_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

token = 's4mp13_4u7h_70k3n'

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = update_check.sync(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)

Execution

from dqops import client
from dqops.client.api.checks import update_check
from dqops.client.models import CheckDefinitionModel, \
                                DefaultRuleSeverityLevel

token = 's4mp13_4u7h_70k3n'

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

request_body = CheckDefinitionModel(
    check_name='sample_check',
    sensor_name='sample_target/sample_category/table/volume/row_count',
    rule_name='sample_target/sample_category/sample_rule',
    help_text='Sample help text',
    standard=False,
    default_severity=DefaultRuleSeverityLevel.ERROR,
    custom=True,
    built_in=False,
    can_edit=True
)

call_result = await update_check.asyncio(
    'sample_target/sample_category/sample_check',
    client=dqops_client,
    json_body=request_body
)