ConfigDefinitionAPI

Class for CRUDL of Configuration Definitions.

Initialization

from tartarus_lib import TartarusAPIClient

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

cd_client = tartarus.config_definitions

Methods

reate Config Definition

Create a new configuration definition.

cd_create = cd_client.create(
    config_definition_key="test_config_definition",
    json_schema= <SCHEMA>,
    indexes= <INDEXES>
)

Parameters:

config_definition_key · string · required

The key for the config definition.

json_schema · JSON · default: "None"

The JSON schema for the config definition.

indexes · JSON · default: "None"

The list of indexes for the config definition.

Returns: Success response with dictionary of the config-def data.

ead Config Definition

Read a configuration definition.

cd_read = cd_client.retrieve(
    config_definition_key="test_config_definition",
)

Parameters:

config_definition_key · string · required

The key for the config definition.

Returns: Dictionary of the config-def data.

pdate Config Definition

Update a configuration definition.

cd_update = cd_client.update(
    config_definition_key="test_config_definition",
    indexes=<INDEXES>
)

Parameters:

config_definition_key · string · required

The key for the config definition.

indexes · string · required

The list of indexes for the config definition.

Returns: Dictionary of the config-def data.

elete Config Definition

Delete a configuration definition.

cd_delete = cd_client.delete(
    config_definition_key="test_config_definition",
)

Parameters:

config_definition_key · string · required

The key for the config definition.

Returns: Successful response.

ist Config Definition

List a configuration.

cd_list = cd_client.list(
    page = 1,
    limit = 10,
    sort_by = "modified_at",
    sort_order = "desc",
    search = None
)

Parameters:

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 config-def data.