ConfigAPI

Class for CRUDL of Configurations.

Initialization

from tartarus_lib import TartarusAPIClient

tartarus = TartarusAPIClient(
    base_url="<BASE_URL>",
    api_key="<API_KEY>"
)

c_client = tartarus.configs

Methods

reate Config

Create a new configuration.

c_create = c_client.create(
    config_definition_key="test_config_definition",
    config_key="test_config",
    data={"test": "data"}
)

Parameters:

config_definition_key · string · required

Name of the Configuration table.

config_key · string · required

Name of the configuration.

data · json · required

Schema of config.

Returns: Success response with dictionary of the configuration data.

ead Config

Read a configuration.

c_read = c_client.retrieve(
    config_definition_key="test_config_definition",
    config_key="test_config",
)

Parameters:

config_definition_key · string · required

Name of the Configuration table.

config_key · string · required

Name of the configuration to fetch.

Returns: Dictionary of the configuration data.

pdate Config

Update a configuration.

c_update = c_client.update(
    config_definition_key="test_config_definition",
    config_key="test_config",
    data={"test": "dat"}
)

Parameters:

config_definition_key · string · required

Name of the Configuration table.

config_key · string · required

Name of the configuration.

data : Schema of config.

Returns: Dictionary of the configuration data.

elete Config

Delete a configuration.

c_delete = c_client.delete(
    config_definition_key="test_config_definition",
    config_key="test_config",
)

Parameters:

config_definition_key · string · required

Name of the Configuration table.

config_key · string · required

Name of the configuration.

Returns: Successful response.

ist Config

List a configuration.

c_list = c_client.list(
    config_definition_key="test_config_definition",
    config_key="test_config",
    page = 1,
    limit = 10,
    sort_by = "modified_at",
    sort_order = "desc",
    search = None
)

Parameters:

config_definition_key · string · required

Name of the Configuration table.

page · int · default: "1"

Number of pages.

limit · int · default: "10"

Number of configs in each page.

sort_by · string · default: "modified_at"

Sorting condition.

sort_order · string · default: "desc"

The order to sort by.

search · string · default: "None"

Search by keywords.

Returns: List of Dictionary of the configuration data.