Skip to content

Last updated: July 22, 2025

DQOps REST API log_shipping operations

Log shipping controller that accepts logs sent from a web application or external tools and aggregates them in the local DQOps instance logs.


log_debug

Logs an information message in the server's logs as a debug severity log entry.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/logs/debug

Request body

 Description                       Data type   Required 
Log entry ExternalLogEntry

Usage examples

Execution

curl -X POST http://localhost:8888/api/logs/debug^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"window_location\":\"window.location\",\"message\":\"Sample log message.\"}"

Execution

from dqops import client
from dqops.client.api.log_shipping import log_debug
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_debug
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_debug
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_debug
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

log_error

Logs an information message in the server's logs as an error severity log entry.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/logs/error

Request body

 Description                       Data type   Required 
Log entry ExternalLogEntry

Usage examples

Execution

curl -X POST http://localhost:8888/api/logs/error^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"window_location\":\"window.location\",\"message\":\"Sample log message.\"}"

Execution

from dqops import client
from dqops.client.api.log_shipping import log_error
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_error
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_error
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_error
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

log_info

Logs an information message in the server's logs as an info severity log entry.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/logs/info

Request body

 Description                       Data type   Required 
Log entry ExternalLogEntry

Usage examples

Execution

curl -X POST http://localhost:8888/api/logs/info^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"window_location\":\"window.location\",\"message\":\"Sample log message.\"}"

Execution

from dqops import client
from dqops.client.api.log_shipping import log_info
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_info
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_info
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_info
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

log_warn

Logs an information message in the server's logs as a warn severity log entry.

Follow the link to see the source code on GitHub.

POST

http://localhost:8888/api/logs/warn

Request body

 Description                       Data type   Required 
Log entry ExternalLogEntry

Usage examples

Execution

curl -X POST http://localhost:8888/api/logs/warn^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"window_location\":\"window.location\",\"message\":\"Sample log message.\"}"

Execution

from dqops import client
from dqops.client.api.log_shipping import log_warn
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_warn
from dqops.client.models import ExternalLogEntry

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_warn
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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

Execution

from dqops import client
from dqops.client.api.log_shipping import log_warn
from dqops.client.models import ExternalLogEntry

token = 's4mp13_4u7h_70k3n'

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

request_body = ExternalLogEntry(
    window_location='window.location',
    message='Sample log message.'
)

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