Hydrolix Config API

https://docs.hydrolix.io/latest/openapi/config-api/
Admin
Hydrolix Config API is a REST API for configuring Hydrolix entities including users, projects,...
Tokens:16,470
Snippets:23
Trust Score:9.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /config/v1/activity/

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Retrieves audit activities. Supports filtering by various parameters like date, user, resource, and pagination.

```APIDOC
## GET /config/v1/activity/

### Description
Get audit activities. This endpoint allows fetching a list of audit activities with various filtering and sorting options.

### Method
GET

### Endpoint
/config/v1/activity/

### Parameters
#### Query Parameters
- **action** (string) - Optional - Filter by action performed.
- **direction** (string) - Optional - Sort order for activities (e.g., 'asc', 'desc'). Defaults to 'asc'.
- **ip_address** (string) - Optional - Filter by IP address.
- **max_date** (string) - Optional - Filter activities up to this date.
- **min_date** (string) - Optional - Filter activities from this date.
- **page** (integer) - Optional - Page number for pagination.
- **page_size** (integer) - Optional - Number of items per page.
- **resource_id** (string) - Optional - Filter by resource ID.
- **resource_type** (string) - Optional - Filter by resource type.
- **target_user_id** (string) - Optional - Filter by the ID of the target user.
- **target_username** (string) - Optional - Filter by the username of the target user.
- **user** (string) - Optional - Filter by username.
- **user_id** (string) - Optional - Filter by user ID.

### Request Example
```
GET https://{hostname}/config/v1/activity/?action=create&user=admin&page=1&page_size=20
```

### Response
#### Success Response (200)
- **activities** (array) - A list of audit activity objects.
  - **id** (string) - The unique identifier of the activity.
  - **timestamp** (string) - The time the activity occurred.
  - **user** (string) - The username of the user who performed the activity.
  - **action** (string) - The action performed.
  - **resource_type** (string) - The type of resource affected.
  - **resource_id** (string) - The ID of the resource affected.
  - **details** (object) - Additional details about the activity.

#### Response Example
```json
{
  "activities": [
    {
      "id": "activity-123",
      "timestamp": "2023-10-27T10:00:00Z",
      "user": "admin",
      "action": "create",
      "resource_type": "transform_template",
      "resource_id": "template-abc",
      "details": {
        "name": "New Template"
      }
    }
  ]
}
```
```

--------------------------------

### Get Activity Logs (Shell)

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Retrieves audit activities from the Hydrolix platform. This operation supports filtering and sorting via query parameters. It requires authentication and can be executed using a cURL command.

```shell
curl -X GET https://{hostname}/config/v1/activity/ \
  -H "Accept: */*" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -G \
  --data-urlencode "action=Value" \
  --data-urlencode "direction=asc" \
  --data-urlencode "ip_address=Value" \
  --data-urlencode "max_date=Value" \
  --data-urlencode "min_date=Value" \
  --data-urlencode "page=Value" \
  --data-urlencode "page_size=Value" \
  --data-urlencode "resource_id=Value" \
  --data-urlencode "resource_type=Value" \
  --data-urlencode "target_user_id=Value" \
  --data-urlencode "target_username=Value" \
  --data-urlencode "user=Value" \
  --data-urlencode "user_id=Value"
```

--------------------------------

### Defaults Operations

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for retrieving default configuration settings.

```APIDOC
## GET /config/v1/defaults/

### Description
Retrieves the system's default configuration settings.

### Method
GET

### Endpoint
/config/v1/defaults/

### Response
#### Success Response (200)
- **defaults** (object) - An object containing default configuration values.

#### Response Example
```json
{
  "defaults": {
    "default_retention_policy": "30d",
    "default_region": "us-east-1"
  }
}
```
```

--------------------------------

### Query Options API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing query options at both project and table levels.

```APIDOC
## GET /config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Description
Retrieves query options for a project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.

### Response
#### Success Response (200)
- **query_options** (object) - The query options for the project.

#### Response Example
```json
{
  "query_options": {
    "timeout_seconds": 60
  }
}
```

## PUT /config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Description
Updates query options for a project.

### Method
PUT

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.

#### Request Body
- **query_options** (object) - Required - The query options to set.

### Request Example
```json
{
  "query_options": {
    "timeout_seconds": 120,
    "max_rows": 10000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Query options updated successfully."
}
```

## PATCH /config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Description
Partially updates query options for a project.

### Method
PATCH

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.

#### Request Body
- **query_options** (object) - Required - The query options to update.

### Request Example
```json
{
  "query_options": {
    "max_rows": 5000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Query options patched successfully."
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/query_options/

### Description
Retrieves query options for a specific table within a project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The ID of the table.

### Response
#### Success Response (200)
- **query_options** (object) - The query options for the table.

#### Response Example
```json
{
  "query_options": {
    "read_only": true
  }
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/query_options_hierarchy/

### Description
Retrieves the query options hierarchy for a specific table within a project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/query_options_hierarchy/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The ID of the table.

### Response
#### Success Response (200)
- **query_options_hierarchy** (object) - The query options hierarchy.

#### Response Example
```json
{
  "query_options_hierarchy": {
    "project_level": {"timeout_seconds": 60},
    "table_level": {"read_only": true}
  }
}
```

## GET /config/v1/orgs/{org_id}/query_options/

### Description
Retrieves global query options for an organization.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.

### Response
#### Success Response (200)
- **query_options** (object) - The global query options for the organization.

#### Response Example
```json
{
  "query_options": {
    "default_timeout": 30
  }
}
```

## PUT /config/v1/orgs/{org_id}/query_options/

### Description
Updates global query options for an organization.

### Method
PUT

### Endpoint
/config/v1/orgs/{org_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.

#### Request Body
- **query_options** (object) - Required - The global query options to set.

### Request Example
```json
{
  "query_options": {
    "default_timeout": 45,
    "default_max_rows": 20000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Global query options updated successfully."
}
```

## PATCH /config/v1/orgs/{org_id}/query_options/

### Description
Partially updates global query options for an organization.

### Method
PATCH

### Endpoint
/config/v1/orgs/{org_id}/query_options/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.

#### Request Body
- **query_options** (object) - Required - The global query options to update.

### Request Example
```json
{
  "query_options": {
    "default_max_rows": 15000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Global query options patched successfully."
}
```
```

--------------------------------

### Kafka Sources API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing Kafka data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting Kafka sources.

```APIDOC
## Kafka Sources API

### Description
Operations for managing Kafka data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting Kafka sources.

### Endpoints

#### List Kafka Sources
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/`

#### Create Kafka Source
- **Method**: POST
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/`

#### Get Kafka Source by ID
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/{id}/`

#### Update Kafka Source by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/{id}/`

#### Partially Update Kafka Source by ID
- **Method**: PATCH
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/{id}/`

#### Delete Kafka Source by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kafka/{id}/`

### Parameters

#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The table ID.
- **id** (string) - Required - The Kafka source ID.
```

--------------------------------

### Dictionaries Operations

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing dictionaries within projects, including file uploads and downloads.

```APIDOC
## GET /config/v1/dictionary_input_formats/

### Description
Retrieves a list of supported dictionary input formats.

### Method
GET

### Endpoint
/config/v1/dictionary_input_formats/

### Response
#### Success Response (200)
- **input_formats** (array) - A list of supported input format names.

#### Response Example
```json
{
  "input_formats": ["json", "csv", "parquet"]
}
```

## GET /config/v1/dictionary_layouts/

### Description
Retrieves a list of supported dictionary layouts.

### Method
GET

### Endpoint
/config/v1/dictionary_layouts/

### Response
#### Success Response (200)
- **layouts** (array) - A list of supported layout types.

#### Response Example
```json
{
  "layouts": ["flat", "nested"]
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/

### Description
Retrieves a list of dictionaries within a specific project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **dictionaries** (array) - A list of dictionary objects.
  - **id** (string) - The unique identifier for the dictionary.
  - **name** (string) - The name of the dictionary.

#### Response Example
```json
{
  "dictionaries": [
    {
      "id": "dict_abc",
      "name": "User Data Dictionary"
    }
  ]
}
```

## POST /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/

### Description
Creates a new dictionary within a specific project.

### Method
POST

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
#### Request Body
- **name** (string) - Required - The name for the new dictionary.
- **layout** (string) - Optional - The layout type for the dictionary.
- **input_format** (string) - Optional - The input format for the dictionary.

### Request Example
```json
{
  "name": "New Product Dictionary",
  "layout": "nested",
  "input_format": "json"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.
- **dictionary_id** (string) - The ID of the newly created dictionary.

#### Response Example
```json
{
  "message": "Dictionary created successfully.",
  "dictionary_id": "dict_def"
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Description
Retrieves details for a specific dictionary within a project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
- **id** (string) - Required - The ID of the dictionary.

### Response
#### Success Response (200)
- **dictionary** (object) - The dictionary details.
  - **id** (string) - The unique identifier for the dictionary.
  - **name** (string) - The name of the dictionary.
  - **layout** (string) - The layout type.
  - **input_format** (string) - The input format.

#### Response Example
```json
{
  "dictionary": {
    "id": "dict_abc",
    "name": "User Data Dictionary",
    "layout": "flat",
    "input_format": "csv"
  }
}
```

## PUT /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Description
Updates details for a specific dictionary within a project.

### Method
PUT

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
- **id** (string) - Required - The ID of the dictionary.
#### Request Body
- **name** (string) - Optional - The new name for the dictionary.
- **layout** (string) - Optional - The new layout type.
- **input_format** (string) - Optional - The new input format.

### Request Example
```json
{
  "name": "Updated User Data Dictionary",
  "layout": "nested"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "message": "Dictionary updated successfully."
}
```

## PATCH /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Description
Partially updates details for a specific dictionary within a project.

### Method
PATCH

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
- **id** (string) - Required - The ID of the dictionary.
#### Request Body
- **name** (string) - Optional - The new name for the dictionary.

### Request Example
```json
{
  "name": "Partially Updated User Data Dictionary"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "message": "Dictionary partially updated successfully."
}
```

## DELETE /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Description
Deletes a specific dictionary from a project.

### Method
DELETE

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
- **id** (string) - Required - The ID of the dictionary.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "message": "Dictionary deleted successfully."
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/activity/

### Description
Retrieves activity logs for a specific dictionary.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/{id}/activity/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
- **id** (string) - Required - The ID of the dictionary.

### Response
#### Success Response (200)
- **activities** (array) - A list of activity logs for the dictionary.

#### Response Example
```json
{
  "activities": [
    {
      "timestamp": "2023-10-27T10:20:00Z",
      "action": "update_schema",
      "details": "Dictionary schema updated."
    }
  ]
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/files/

### Description
Retrieves a list of files associated with dictionaries in a project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/files/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **files** (array) - A list of file objects.
  - **filename** (string) - The name of the file.
  - **size** (integer) - The size of the file in bytes.
  - **uploaded_at** (string) - The timestamp when the file was uploaded.

#### Response Example
```json
{
  "files": [
    {
      "filename": "data.json",
      "size": 1024,
      "uploaded_at": "2023-10-27T10:25:00Z"
    }
  ]
}
```

## POST /config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/files/

### Description
Uploads a file to be associated with dictionaries in a project.

### Method
POST

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/dictionaries/files/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The ID of the organization.
- **project_id** (string) - Required - The ID of the project.
#### Request Body
- **file** (file) - Required - The file to upload.
- **dictionary_id** (string) - Optional - The ID of the dictionary to associate the file with.

### Request Example
```json
{
  "file": "<binary file data
```

--------------------------------

### Tasks API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing tasks within Hydrolix IO, including retrieving task lists, specific tasks, cleaning tasks, and accessing task events.

```APIDOC
## Tasks API

### Description
Operations for managing tasks within Hydrolix IO, including retrieving task lists, specific tasks, cleaning tasks, and accessing task events.

### Endpoints

#### List Tasks
- **Method**: GET
- **Endpoint**: `/config/v1/tasks/`

#### Get Task by ID
- **Method**: GET
- **Endpoint**: `/config/v1/tasks/{id}/`

#### Clean Task
- **Method**: POST
- **Endpoint**: `/config/v1/tasks/clean/`

#### List Task Events
- **Method**: GET
- **Endpoint**: `/config/v1/tasks/events/`

#### Get Task Event by ID
- **Method**: GET
- **Endpoint**: `/config/v1/tasks/events/{id}/`

### Parameters

#### Path Parameters
- **id** (string) - Required - The task ID.
```

--------------------------------

### Users API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing users, including retrieval, partial updates, deletion, and role management.

```APIDOC
## Users API

### Description
Operations for managing users, including retrieval, partial updates, deletion, and role management.

### Methods
- GET /config/v1/users/
- GET /config/v1/users/{id}/
- PATCH /config/v1/users/{id}/
- DELETE /config/v1/users/{id}/
- POST /config/v1/users/{id}/add_roles/
- POST /config/v1/users/{id}/remove_roles/
- GET /config/v1/users/current/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.
```

--------------------------------

### Tables API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing tables within a Hydrolix project, including their metadata, partitions, and statistics.

```APIDOC
## GET /config/v1/orgs/{org_id}/projects/{project_id}/tables/

### Description
Retrieves a list of tables for a given organization and project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.

### Response
#### Success Response (200)
- **tables** (array) - A list of table objects.

#### Response Example
```json
{
  "tables": [
    {
      "id": "table-xyz",
      "name": "example_table"
    }
  ]
}
```

## POST /config/v1/orgs/{org_id}/projects/{project_id}/tables/

### Description
Creates a new table for a given organization and project.

### Method
POST

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.

#### Request Body
- **name** (string) - Required - The name of the table.
- **schema** (object) - Optional - The schema definition for the table.

### Request Example
```json
{
  "name": "new_data_table",
  "schema": {
    "type": "object",
    "properties": {
      "timestamp": {"type": "string", "format": "date-time"},
      "value": {"type": "number"}
    }
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the created table.
- **name** (string) - The name of the created table.

#### Response Example
```json
{
  "id": "table-abc",
  "name": "new_data_table"
}
```

## GET /config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Description
Retrieves a specific table by its ID for a given organization and project.

### Method
GET

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **id** (string) - Required - The ID of the table to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The ID of the table.
- **name** (string) - The name of the table.
- **schema** (object) - The schema definition of the table.

#### Response Example
```json
{
  "id": "table-xyz",
  "name": "example_table",
  "schema": {
    "type": "object",
    "properties": {
      "timestamp": {"type": "string", "format": "date-time"},
      "value": {"type": "number"}
    }
  }
}
```

## PUT /config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Description
Updates an existing table by its ID for a given organization and project.

### Method
PUT

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **id** (string) - Required - The ID of the table to update.

#### Request Body
- **name** (string) - Optional - The new name for the table.
- **schema** (object) - Optional - The new schema definition for the table.

### Request Example
```json
{
  "schema": {
    "type": "object",
    "properties": {
      "timestamp": {"type": "string", "format": "date-time"},
      "value": {"type": "number"},
      "category": {"type": "string"}
    }
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the updated table.
- **name** (string) - The name of the updated table.
- **schema** (object) - The updated schema definition of the table.

#### Response Example
```json
{
  "id": "table-xyz",
  "name": "example_table",
  "schema": {
    "type": "object",
    "properties": {
      "timestamp": {"type": "string", "format": "date-time"},
      "value": {"type": "number"},
      "category": {"type": "string"}
    }
  }
}
```

## PATCH /config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Description
Partially updates an existing table by its ID for a given organization and project.

### Method
PATCH

### Endpoint
/config/v1/orgs/{org_id}/projects/{project_id}/tables/{id}/

### Parameters
#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **id** (string) - Required - The ID of the table to update.

#### Request Body
- **name** (string) -
```

--------------------------------

### Siem Sources API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing SIEM data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting SIEM sources.

```APIDOC
## Siem Sources API

### Description
Operations for managing SIEM data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting SIEM sources.

### Endpoints

#### List SIEM Sources
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/`

#### Create SIEM Source
- **Method**: POST
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/`

#### Get SIEM Source by ID
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/{id}/`

#### Update SIEM Source by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/{id}/`

#### Partially Update SIEM Source by ID
- **Method**: PATCH
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/{id}/`

#### Delete SIEM Source by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/siem/{id}/`

### Parameters

#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The table ID.
- **id** (string) - Required - The SIEM source ID.
```

--------------------------------

### Transform Templates API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing transform templates, including creation, retrieval, update, and deletion.

```APIDOC
## Transform Templates API

### Description
Operations for managing transform templates, including creation, retrieval, update, and deletion.

### Methods
- GET /config/v1/transform_templates/
- POST /config/v1/transform_templates/
- GET /config/v1/transform_templates/{id}/
- PUT /config/v1/transform_templates/{id}/
- PATCH /config/v1/transform_templates/{id}/
- DELETE /config/v1/transform_templates/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the transform template.
```

--------------------------------

### Storages API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing storage configurations within Hydrolix IO organizations. This includes creating, retrieving, updating, deleting, and querying storage-related information.

```APIDOC
## Storages API

### Description
Operations for managing storage configurations within Hydrolix IO organizations. This includes creating, retrieving, updating, deleting, and querying storage-related information.

### Endpoints

#### List Storages
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/`

#### Create Storage
- **Method**: POST
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/`

#### Get Storage by ID
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/`

#### Update Storage by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/`

#### Partially Update Storage by ID
- **Method**: PATCH
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/`

#### Delete Storage by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/`

#### Get Storage Catalog
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/catalog/`

#### Get Related Resources for Storage
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/related_resources/`

#### Get Tables for Storage
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/storages/{id}/tables/`

### Parameters

#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **id** (string) - Required - The storage ID.
```

--------------------------------

### Views API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing views within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting views.

```APIDOC
## Views API

### Description
Operations for managing views within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting views.

### Endpoints

#### List Views
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/views/`

#### Create View
- **Method**: POST
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/views/`

#### Get View by ID
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/views/{id}/`

#### Update View by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/views/{id}/`

#### Delete View by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/views/{id}/`

### Parameters

#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The table ID.
- **id** (string) - Required - The view ID.
```

--------------------------------

### Kinesis Sources API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing Kinesis data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting Kinesis sources.

```APIDOC
## Kinesis Sources API

### Description
Operations for managing Kinesis data sources within Hydrolix IO projects. This includes creating, retrieving, updating, and deleting Kinesis sources.

### Endpoints

#### List Kinesis Sources
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/`

#### Create Kinesis Source
- **Method**: POST
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/`

#### Get Kinesis Source by ID
- **Method**: GET
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/{id}/`

#### Update Kinesis Source by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/{id}/`

#### Partially Update Kinesis Source by ID
- **Method**: PATCH
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/{id}/`

#### Delete Kinesis Source by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/orgs/{org_id}/projects/{project_id}/tables/{table_id}/sources/kinesis/{id}/`

### Parameters

#### Path Parameters
- **org_id** (string) - Required - The organization ID.
- **project_id** (string) - Required - The project ID.
- **table_id** (string) - Required - The table ID.
- **id** (string) - Required - The Kinesis source ID.
```

--------------------------------

### Auth Operations

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations related to authentication, including identity providers, login, and password management.

```APIDOC
## GET /config/v1/auth/identity_providers/

### Description
Retrieves a list of configured identity providers.

### Method
GET

### Endpoint
/config/v1/auth/identity_providers/

### Response
#### Success Response (200)
- **identity_providers** (array) - A list of identity providers.
  - **id** (string) - The unique identifier for the identity provider.
  - **name** (string) - The name of the identity provider.
  - **type** (string) - The type of the identity provider (e.g., 'oauth2', 'saml').

#### Response Example
```json
{
  "identity_providers": [
    {
      "id": "idp_abc",
      "name": "Google OAuth",
      "type": "oauth2"
    }
  ]
}
```

## GET /config/v1/auth_logs/

### Description
Retrieves authentication logs.

### Method
GET

### Endpoint
/config/v1/auth_logs/

### Response
#### Success Response (200)
- **auth_logs** (array) - A list of authentication logs.
  - **timestamp** (string) - The time of the authentication event.
  - **user** (string) - The user involved in the event.
  - **ip_address** (string) - The IP address from which the event occurred.
  - **status** (string) - The status of the authentication event (e.g., 'success', 'failure').

#### Response Example
```json
{
  "auth_logs": [
    {
      "timestamp": "2023-10-27T10:05:00Z",
      "user": "user@example.com",
      "ip_address": "192.168.1.100",
      "status": "success"
    }
  ]
}
```

## PUT /config/v1/change_password/

### Description
Changes the password for the authenticated user.

### Method
PUT

### Endpoint
/config/v1/change_password/

### Parameters
#### Request Body
- **current_password** (string) - Required - The user's current password.
- **new_password** (string) - Required - The user's new password.

### Request Example
```json
{
  "current_password": "old_password",
  "new_password": "new_secure_password"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the password was changed successfully.

#### Response Example
```json
{
  "message": "Password changed successfully."
}
```

## GET /config/v1/login/

### Description
Retrieves information about the current login session or available login methods.

### Method
GET

### Endpoint
/config/v1/login/

### Response
#### Success Response (200)
- **login_info** (object) - Information about the login session or methods.

#### Response Example
```json
{
  "login_info": {
    "is_logged_in": true,
    "username": "user@example.com"
  }
}
```

## POST /config/v1/login/

### Description
Logs in a user to the system.

### Method
POST

### Endpoint
/config/v1/login/

### Parameters
#### Request Body
- **username** (string) - Required - The user's username or email.
- **password** (string) - Required - The user's password.

### Request Example
```json
{
  "username": "user@example.com",
  "password": "user_password"
}
```

### Response
#### Success Response (200)
- **token** (string) - An authentication token for subsequent requests.
- **expires_in** (integer) - The expiration time of the token in seconds.

#### Response Example
```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600
}
```

## POST /config/v1/password_reset_confirm/

### Description
Confirms a password reset request using a token.

### Method
POST

### Endpoint
/config/v1/password_reset_confirm/

### Parameters
#### Request Body
- **token** (string) - Required - The password reset token.
- **new_password** (string) - Required - The new password for the user.

### Request Example
```json
{
  "token": "reset_token_123",
  "new_password": "new_secure_password"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the password has been reset.

#### Response Example
```json
{
  "message": "Password reset successfully."
}
```

## POST /config/v1/reset_password/

### Description
Initiates a password reset process for a user.

### Method
POST

### Endpoint
/config/v1/reset_password/

### Parameters
#### Request Body
- **email** (string) - Required - The email address of the user requesting a password reset.

### Request Example
```json
{
  "email": "user@example.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - A message indicating that a password reset email has been sent.

#### Response Example
```json
{
  "message": "Password reset email sent. Please check your inbox."
}
```
```

--------------------------------

### Pools API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing compute pools within Hydrolix IO. This includes creating, retrieving, updating, deleting pools, and managing ingest endpoints and resets.

```APIDOC
## Pools API

### Description
Operations for managing compute pools within Hydrolix IO. This includes creating, retrieving, updating, deleting pools, and managing ingest endpoints and resets.

### Endpoints

#### List Pools
- **Method**: GET
- **Endpoint**: `/config/v1/pools/`

#### Create Pool
- **Method**: POST
- **Endpoint**: `/config/v1/pools/`

#### Get Pool by ID
- **Method**: GET
- **Endpoint**: `/config/v1/pools/{id}/`

#### Update Pool by ID
- **Method**: PUT
- **Endpoint**: `/config/v1/pools/{id}/`

#### Partially Update Pool by ID
- **Method**: PATCH
- **Endpoint**: `/config/v1/pools/{id}/`

#### Delete Pool by ID
- **Method**: DELETE
- **Endpoint**: `/config/v1/pools/{id}/`

#### List Pool Ingest Endpoints
- **Method**: GET
- **Endpoint**: `/config/v1/pools/ingest_endpoints/`

#### Reset Pool Redpanda
- **Method**: POST
- **Endpoint**: `/config/v1/pools/reset_redpanda/`

### Parameters

#### Path Parameters
- **id** (string) - Required - The pool ID.
```

--------------------------------

### Service Accounts API

Source: https://docs.hydrolix.io/latest/openapi/config-api/index

Operations for managing service accounts and their associated tokens within Hydrolix IO. This includes creating, retrieving, deleting service accounts, and managing tokens.

```APIDOC
## Service Accounts API

### Description
Operations for managing service accounts and their associated tokens within Hydrolix IO. This includes creating, retrieving, deleting service accounts, and managing tokens.

### Endpoints

#### List Service Accounts
- **Method**: GET
- **Endpoint**: `/config/v1/service_accounts/`

#### Create Service Account
- **Method**: POST
- **Endpoint**: `/config/v1/service_accounts/`

#### Get Service Account by UUID
- **Method**: GET
- **Endpoint**: `/config/v1/service_accounts/{uuid}/`

#### Delete Service Account by UUID
- **Method**: DELETE
- **Endpoint**: `/config/v1/service_accounts/{uuid}/`

#### Create Service Account Token
- **Method**: POST
- **Endpoint**: `/config/v1/service_accounts/{uuid}/tokens/`

#### Delete Service Account Token
- **Method**: DELETE
- **Endpoint**: `/config/v1/service_accounts/{uuid}/tokens/`

### Parameters

#### Path Parameters
- **uuid** (string) - Required - The service account UUID.
```
Tokens:
Raw