Skip to main content

IncQuery Server Web API

Project description

incqueryserver-api-python-client

This package offers an easy way to connect to a running IncQuery Server instance.

Connect to a running IncQuery Server

from iqs_api import connect

No authentication

iqs = connect("https://incqueryserver.url.com")

OpenID Connect (OIDC)

token = "token"

iqs = connect(
    address="https://incqueryserver.url.com",
    auth_header_name="Authorization",
    auth_header_value=f"Bearer {token}",
    use_auth_header=True
)

Basic Authentication

iqs = connect(
    address="https://incqueryserver.url.com",
    username="username",
    password="password"
)

Issue API calls

GET request example:

response = iqs.server_management.get_server_info()

POST request example:

from iqs_client import models

response = iqs.demo.update_model_compartment_index(
    index_compartment=models.IndexCompartment(
        model_compartment="model_compartment_uri",
        indexes=["index1", "index2"]
    )
)

IMPORTANT: It is recommended to provide parameters as keyword arguments (opposed to positional)

Other options

Configure self-signed certificate

from iqs_client import Configuration

custom_config = Configuration()
custom_config.ssl_ca_cert = "path/to/cert.cer"

iqs = connect(
    address="https://incqueryserver.url.com",
    configuration=custom_config
)

Disable SSL verification

from iqs_client import Configuration

custom_config = Configuration()
custom_config.verify_ssl = False

iqs = connect(
    address="https://incqueryserver.url.com",
    configuration=custom_config
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

incqueryserver-api-python-client-0.27.0.tar.gz (167.2 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page