formkiq_client.SystemManagementApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_api_key	POST /sites/{siteId}/apiKeys	Add API Key
delete_api_key	DELETE /sites/{siteId}/apiKeys/{apiKey}	Delete API Key
delete_opensearch_index	DELETE /sites/{siteId}/opensearch/index	Deletst site(s) OpenSearch index
get_api_keys	GET /sites/{siteId}/apiKeys	Get API Keys
get_configuration	GET /sites/{siteId}/configuration	Get site configuration
get_opensearch_index	GET /sites/{siteId}/opensearch/index	Get site(s) OpenSearch index settings
get_sites	GET /sites	Get site(s) access
get_version	GET /version	Get FormKiQ version
set_opensearch_index	PUT /sites/{siteId}/opensearch/index	Set site(s) OpenSearch index settings
update_configuration	PATCH /sites/{siteId}/configuration	Update site configuration

add_api_key

AddApiKeyResponse add_api_key(site_id, add_api_key_request)

Add API Key

Adds a new API Key

Example

import formkiq_client
from formkiq_client.models.add_api_key_request import AddApiKeyRequest
from formkiq_client.models.add_api_key_response import AddApiKeyResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    add_api_key_request = {"name":"My API Key"} # AddApiKeyRequest | 

    try:
        # Add API Key
        api_response = api_instance.add_api_key(site_id, add_api_key_request)
        print("The response of SystemManagementApi->add_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->add_api_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
add_api_key_request	AddApiKeyRequest

Return type

AddApiKeyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_api_key

DeleteApiKeyResponse delete_api_key(site_id, api_key)

Delete API Key

Adds a new API Key

Example

import formkiq_client
from formkiq_client.models.delete_api_key_response import DeleteApiKeyResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    api_key = 'api_key_example' # str | API Key

    try:
        # Delete API Key
        api_response = api_instance.delete_api_key(site_id, api_key)
        print("The response of SystemManagementApi->delete_api_key:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_api_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
api_key	str	API Key

Return type

DeleteApiKeyResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_opensearch_index

DeleteResponse delete_opensearch_index(site_id)

Deletst site(s) OpenSearch index

Deletes the OpenSearch index

Example

import formkiq_client
from formkiq_client.models.delete_response import DeleteResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Deletst site(s) OpenSearch index
        api_response = api_instance.delete_opensearch_index(site_id)
        print("The response of SystemManagementApi->delete_opensearch_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->delete_opensearch_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_api_keys

GetApiKeysResponse get_api_keys(site_id)

Get API Keys

Returns the list of ApiKeys

Example

import formkiq_client
from formkiq_client.models.get_api_keys_response import GetApiKeysResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get API Keys
        api_response = api_instance.get_api_keys(site_id)
        print("The response of SystemManagementApi->get_api_keys:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_api_keys: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetApiKeysResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_configuration

GetConfigurationResponse get_configuration(site_id)

Get site configuration

Returns the list of sites that the user has access to

Example

import formkiq_client
from formkiq_client.models.get_configuration_response import GetConfigurationResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site configuration
        api_response = api_instance.get_configuration(site_id)
        print("The response of SystemManagementApi->get_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetConfigurationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_opensearch_index

GetOpenSearchIndexResponse get_opensearch_index(site_id)

Get site(s) OpenSearch index settings

Returns the OpenSearch index settings

Example

import formkiq_client
from formkiq_client.models.get_open_search_index_response import GetOpenSearchIndexResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier

    try:
        # Get site(s) OpenSearch index settings
        api_response = api_instance.get_opensearch_index(site_id)
        print("The response of SystemManagementApi->get_opensearch_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_opensearch_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier

Return type

GetOpenSearchIndexResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sites

GetSitesResponse get_sites()

Get site(s) access

Returns the list of sites that the user has access to

Example

import formkiq_client
from formkiq_client.models.get_sites_response import GetSitesResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)

    try:
        # Get site(s) access
        api_response = api_instance.get_sites()
        print("The response of SystemManagementApi->get_sites:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_sites: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetSitesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_version

GetVersionResponse get_version()

Get FormKiQ version

Return the version of FormKiQ

Example

import formkiq_client
from formkiq_client.models.get_version_response import GetVersionResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)

    try:
        # Get FormKiQ version
        api_response = api_instance.get_version()
        print("The response of SystemManagementApi->get_version:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->get_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetVersionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_opensearch_index

SetOpenSearchIndexResponse set_opensearch_index(site_id, set_open_search_index_request)

Set site(s) OpenSearch index settings

Sets the OpenSearch index settings

Example

import formkiq_client
from formkiq_client.models.set_open_search_index_request import SetOpenSearchIndexRequest
from formkiq_client.models.set_open_search_index_response import SetOpenSearchIndexResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    set_open_search_index_request = formkiq_client.SetOpenSearchIndexRequest() # SetOpenSearchIndexRequest | 

    try:
        # Set site(s) OpenSearch index settings
        api_response = api_instance.set_opensearch_index(site_id, set_open_search_index_request)
        print("The response of SystemManagementApi->set_opensearch_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->set_opensearch_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
set_open_search_index_request	SetOpenSearchIndexRequest

Return type

SetOpenSearchIndexResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_configuration

UpdateConfigurationResponse update_configuration(site_id, update_configuration_request)

Update site configuration

Update the System Management configuration

Example

import formkiq_client
from formkiq_client.models.update_configuration_request import UpdateConfigurationRequest
from formkiq_client.models.update_configuration_response import UpdateConfigurationResponse
from formkiq_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = formkiq_client.SystemManagementApi(api_client)
    site_id = 'site_id_example' # str | Site Identifier
    update_configuration_request = {"chatGptApiKey":"ABC","maxContentLengthBytes":"1000000","maxDocuments":"1000","maxWebhooks":"10","notificationEmail":"<email>"} # UpdateConfigurationRequest | 

    try:
        # Update site configuration
        api_response = api_instance.update_configuration(site_id, update_configuration_request)
        print("The response of SystemManagementApi->update_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemManagementApi->update_configuration: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_id	str	Site Identifier
update_configuration_request	UpdateConfigurationRequest

Return type

UpdateConfigurationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -
400	400 OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SystemManagementApi.md

Latest commit

History

SystemManagementApi.md

File metadata and controls

formkiq_client.SystemManagementApi

add_api_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_api_key

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_opensearch_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_api_keys

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_opensearch_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_sites

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_opensearch_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details