Last updated: July 22, 2025

DQOps REST API environment operations

DQOps environment and configuration controller, provides access to the DQOps configuration, current user's information and issue local API Keys for the calling user.

---

download_logs

Downloads logs as a zip file

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/environment/logs/download

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

curl http://localhost:8888/api/environment/logs/download^
    -H "Accept: application/json"

Execution

from dqops import client
from dqops.client.api.environment import download_logs

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

call_result = download_logs.sync(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.environment import download_logs

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

call_result = await download_logs.asyncio(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.environment import download_logs

token = 's4mp13_4u7h_70k3n'

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

call_result = download_logs.sync(
    client=dqops_client
)

Execution

from dqops import client
from dqops.client.api.environment import download_logs

token = 's4mp13_4u7h_70k3n'

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

call_result = await download_logs.asyncio(
    client=dqops_client
)

---

get_dqo_settings

Returns all effective DQOps configuration settings.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/environment/settings

Return value

Property name	Description	Data type
dqo_settings_model		DqoSettingsModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

{
  "properties" : { }
}

Execution

from dqops import client
from dqops.client.api.environment import get_dqo_settings

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

call_result = get_dqo_settings.sync(
    client=dqops_client
)

Expand to see the returned result

DqoSettingsModel(
    properties={

    }
)

Execution

from dqops import client
from dqops.client.api.environment import get_dqo_settings

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

call_result = await get_dqo_settings.asyncio(
    client=dqops_client
)

Expand to see the returned result

DqoSettingsModel(
    properties={

    }
)

Execution

from dqops import client
from dqops.client.api.environment import get_dqo_settings

token = 's4mp13_4u7h_70k3n'

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

call_result = get_dqo_settings.sync(
    client=dqops_client
)

Expand to see the returned result

DqoSettingsModel(
    properties={

    }
)

Execution

from dqops import client
from dqops.client.api.environment import get_dqo_settings

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_dqo_settings.asyncio(
    client=dqops_client
)

Expand to see the returned result

DqoSettingsModel(
    properties={

    }
)

---

get_user_profile

Returns the profile of the current user.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/environment/profile

Return value

Property name	Description	Data type
dqo_user_profile_model		DqoUserProfileModel

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

{
  "data_quality_data_warehouse_enabled" : false,
  "can_manage_account" : false,
  "can_view_any_object" : false,
  "can_manage_scheduler" : false,
  "can_cancel_jobs" : false,
  "can_run_checks" : false,
  "can_delete_data" : false,
  "can_collect_statistics" : false,
  "can_manage_data_sources" : false,
  "can_synchronize" : false,
  "can_edit_comments" : false,
  "can_edit_labels" : false,
  "can_manage_definitions" : false,
  "can_compare_tables" : false,
  "can_manage_users" : false,
  "can_manage_and_view_shared_credentials" : false,
  "can_change_own_password" : false,
  "can_use_data_domains" : false,
  "can_synchronize_to_data_catalog" : false,
  "can_use_ai_anomaly_detection" : false,
  "can_logout" : false
}

Execution

from dqops import client
from dqops.client.api.environment import get_user_profile

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

call_result = get_user_profile.sync(
    client=dqops_client
)

Expand to see the returned result

DqoUserProfileModel(
    data_quality_data_warehouse_enabled=False,
    can_manage_account=False,
    can_view_any_object=False,
    can_manage_scheduler=False,
    can_cancel_jobs=False,
    can_run_checks=False,
    can_delete_data=False,
    can_collect_statistics=False,
    can_manage_data_sources=False,
    can_synchronize=False,
    can_edit_comments=False,
    can_edit_labels=False,
    can_manage_definitions=False,
    can_compare_tables=False,
    can_manage_users=False,
    can_manage_and_view_shared_credentials=False,
    can_change_own_password=False,
    can_use_data_domains=False,
    can_synchronize_to_data_catalog=False,
    can_use_ai_anomaly_detection=False,
    can_logout=False
)

Execution

from dqops import client
from dqops.client.api.environment import get_user_profile

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

call_result = await get_user_profile.asyncio(
    client=dqops_client
)

Expand to see the returned result

DqoUserProfileModel(
    data_quality_data_warehouse_enabled=False,
    can_manage_account=False,
    can_view_any_object=False,
    can_manage_scheduler=False,
    can_cancel_jobs=False,
    can_run_checks=False,
    can_delete_data=False,
    can_collect_statistics=False,
    can_manage_data_sources=False,
    can_synchronize=False,
    can_edit_comments=False,
    can_edit_labels=False,
    can_manage_definitions=False,
    can_compare_tables=False,
    can_manage_users=False,
    can_manage_and_view_shared_credentials=False,
    can_change_own_password=False,
    can_use_data_domains=False,
    can_synchronize_to_data_catalog=False,
    can_use_ai_anomaly_detection=False,
    can_logout=False
)

Execution

from dqops import client
from dqops.client.api.environment import get_user_profile

token = 's4mp13_4u7h_70k3n'

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

call_result = get_user_profile.sync(
    client=dqops_client
)

Expand to see the returned result

DqoUserProfileModel(
    data_quality_data_warehouse_enabled=False,
    can_manage_account=False,
    can_view_any_object=False,
    can_manage_scheduler=False,
    can_cancel_jobs=False,
    can_run_checks=False,
    can_delete_data=False,
    can_collect_statistics=False,
    can_manage_data_sources=False,
    can_synchronize=False,
    can_edit_comments=False,
    can_edit_labels=False,
    can_manage_definitions=False,
    can_compare_tables=False,
    can_manage_users=False,
    can_manage_and_view_shared_credentials=False,
    can_change_own_password=False,
    can_use_data_domains=False,
    can_synchronize_to_data_catalog=False,
    can_use_ai_anomaly_detection=False,
    can_logout=False
)

Execution

from dqops import client
from dqops.client.api.environment import get_user_profile

token = 's4mp13_4u7h_70k3n'

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

call_result = await get_user_profile.asyncio(
    client=dqops_client
)

Expand to see the returned result

DqoUserProfileModel(
    data_quality_data_warehouse_enabled=False,
    can_manage_account=False,
    can_view_any_object=False,
    can_manage_scheduler=False,
    can_cancel_jobs=False,
    can_run_checks=False,
    can_delete_data=False,
    can_collect_statistics=False,
    can_manage_data_sources=False,
    can_synchronize=False,
    can_edit_comments=False,
    can_edit_labels=False,
    can_manage_definitions=False,
    can_compare_tables=False,
    can_manage_users=False,
    can_manage_and_view_shared_credentials=False,
    can_change_own_password=False,
    can_use_data_domains=False,
    can_synchronize_to_data_catalog=False,
    can_use_ai_anomaly_detection=False,
    can_logout=False
)

---

issue_api_key

Issues a local API Key for the calling user. This API Key can be used to authenticate using the DQOps REST API client. This API Key should be passed in the "Authorization" HTTP header in the format "Authorization: Bearer <api_key>".

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/environment/issueapikey

Return value

Property name	Description	Data type
string		string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

"sample_string_value"

Execution

from dqops import client
from dqops.client.api.environment import issue_api_key

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

call_result = issue_api_key.sync(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.environment import issue_api_key

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

call_result = await issue_api_key.asyncio(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.environment import issue_api_key

token = 's4mp13_4u7h_70k3n'

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

call_result = issue_api_key.sync(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'

Execution

from dqops import client
from dqops.client.api.environment import issue_api_key

token = 's4mp13_4u7h_70k3n'

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

call_result = await issue_api_key.asyncio(
    client=dqops_client
)

Expand to see the returned result

'sample_string_value'