> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.
# ingestion_configs
> sift/ingestion_configs/v2/ingestion_configs.proto
## Services
*RPC methods exposed by this API.*
### IngestionConfigService
| Method | Request | Response | Description |
| :------------------------- | :---------------------------------------------------------------------- | :------------------------------------------------------------------------ | :---------------------------------------------------------------------- |
| GetIngestionConfig | [GetIngestionConfigRequest](#getingestionconfigrequest) | [GetIngestionConfigResponse](#getingestionconfigresponse) | Retrieves an ingestion config. |
| CreateIngestionConfig | [CreateIngestionConfigRequest](#createingestionconfigrequest) | [CreateIngestionConfigResponse](#createingestionconfigresponse) | Create an ingestion config. |
| ListIngestionConfigs | [ListIngestionConfigsRequest](#listingestionconfigsrequest) | [ListIngestionConfigsResponse](#listingestionconfigsresponse) | List ingestion configs using an optional filter. |
| CreateIngestionConfigFlows | [CreateIngestionConfigFlowsRequest](#createingestionconfigflowsrequest) | [CreateIngestionConfigFlowsResponse](#createingestionconfigflowsresponse) | Create ingestion config [flows](/glossary#flow). |
| ListIngestionConfigFlows | [ListIngestionConfigFlowsRequest](#listingestionconfigflowsrequest) | [ListIngestionConfigFlowsResponse](#listingestionconfigflowsresponse) | List ingestion config [flows](/glossary#flow) using an optional filter. |
## Messages
*Data models used across requests/responses.*
### ChannelConfig
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------------------------------------------------------- | :------- | :---------- |
| name | string | | |
| unit | string | | |
| description | string | | |
| data\_type | [sift.common.type.v1.ChannelDataType](#sift-common-type-v1-channeldatatype) | | |
| enum\_types | [sift.common.type.v1.ChannelEnumType](#sift-common-type-v1-channelenumtype) | repeated | |
| bit\_field\_elements | [sift.common.type.v1.ChannelBitFieldElement](#sift-common-type-v1-channelbitfieldelement) | repeated | |
### CreateIngestionConfigFlowsRequest
The request for a call to `IngestionConfigService_CreateIngestionConfigFlows` to create ingestion config flows.
| Field | Type | Label | Description |
| :-------------------- | :------------------------ | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
| ingestion\_config\_id | string | | |
| flows | [FlowConfig](#flowconfig) | repeated | These flows must have unique names. If you try to send a flow with a name that already exists for an ingestion config, it will return an error. |
### CreateIngestionConfigFlowsResponse
The result of a call to `IngestionConfigService_CreateIngestionConfigFlows`.
*This message has no fields.*
### CreateIngestionConfigRequest
The request for a call to `IngestionConfigService_CreateIngestionConfig` to retrieve ingestion configs.
| Field | Type | Label | Description |
| :--------------- | :------------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| asset\_name | string | | |
| flows | [FlowConfig](#flowconfig) | repeated | |
| organization\_id | string | | |
| client\_key | string | | The `client_key` field is a user-defined string you can supply to uniquely identify an ingestion config (and retrieve it via `GetIngestionConfig`). An error is returned if you try to create an ingestion config with a client\_key that already exists. |
### CreateIngestionConfigResponse
The result of a call to `IngestionConfigService_CreateIngestionConfig`.
| Field | Type | Label | Description |
| :---------------- | :---------------------------------- | :---- | :---------- |
| ingestion\_config | [IngestionConfig](#ingestionconfig) | | |
### FlowConfig
| Field | Type | Label | Description |
| :------- | :------------------------------ | :------- | :---------- |
| name | string | | |
| channels | [ChannelConfig](#channelconfig) | repeated | |
### GetIngestionConfigRequest
The request for a call to `IngestionConfigService_GetIngestionConfig` to retrieve an ingestion config.
| Field | Type | Label | Description |
| :-------------------- | :----- | :---- | :---------- |
| ingestion\_config\_id | string | | |
### GetIngestionConfigResponse
The result of a call to `IngestionConfigService_GetIngestionConfig`.
| Field | Type | Label | Description |
| :---------------- | :---------------------------------- | :---- | :---------- |
| ingestion\_config | [IngestionConfig](#ingestionconfig) | | |
### IngestionConfig
| Field | Type | Label | Description |
| :-------------------- | :----- | :---- | :---------- |
| ingestion\_config\_id | string | | |
| asset\_id | string | | |
| client\_key | string | | |
### ListIngestionConfigFlowsRequest
The request for a call to `IngestionConfigService_ListIngestionConfigFlows` to retrieve ingestion config flows.
| Field | Type | Label | Description |
| :-------------------- | :----- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ingestion\_config\_id | string | | |
| page\_size | uint32 | | The maximum number of ingestion config flows to return. The service may return fewer than this value. If unspecified, at most 50 ingestion config flows will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. |
| page\_token | string | | A page token, received from a previous `ListIngestionConfigFlows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIngestionConfigFlows` must match the call that provided the page token. Optional. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `flow_name`, `flow_id`, `created_date`, and `modified_date`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/ingestion_configs#ingestionconfig). Optional. |
### ListIngestionConfigFlowsResponse
The result of a call to `IngestionConfigService_ListIngestionConfigFlows`.
| Field | Type | Label | Description |
| :---------------- | :------------------------ | :------- | :---------- |
| flows | [FlowConfig](#flowconfig) | repeated | |
| next\_page\_token | string | | |
### ListIngestionConfigsRequest
The request for a call to `IngestionConfigService_ListIngestionConfigs` to retrieve ingestion configs.
| Field | Type | Label | Description |
| :---------- | :----- | :---- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size | uint32 | | The maximum number of ingestion configs to return. The service may return fewer than this value. If unspecified, at most 50 ingestion configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. |
| page\_token | string | | A page token, received from a previous `ListIngestionConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIngestionConfigs` must match the call that provided the page token. Optional. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `ingestion_config_id`, `client_key`, `asset_id`, `created_date`, and `modified_date`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/ingestion_configs#ingestionconfigservice). Optional. |
### ListIngestionConfigsResponse
The result of a call to `IngestionConfigService_ListIngestionConfigs`.
| Field | Type | Label | Description |
| :----------------- | :---------------------------------- | :------- | :---------- |
| ingestion\_configs | [IngestionConfig](#ingestionconfig) | repeated | |
| next\_page\_token | string | | |
## Enums
*Allowed constant values used in message fields.*