Creating an Ingestion Config

To create an ingestion config you will use the IngestionConfigService.CreateIngestionConfig endpoint. The CreateIngestionConfigRequest has the following definition:

message CreateIngestionConfigRequest {
  string asset_name = 1 [(google.api.field_behavior) = REQUIRED];
  repeated FlowConfig flows = 2;
  string organization_id = 3 [(google.api.field_behavior) = OPTIONAL];
  string client_key = 4 [(google.api.field_behavior) = OPTIONAL];
}

The purpose of each field is as follows:

• asset_name: The name of the asset that will get created
• flows: See flows. More details regarding flows will be provided in the next section.
• organization_id: the ID of your organization (not required unless you belong to multiple organizations)
• client_key: an arbitrary client-chosen string used to uniquely identify this ingestion config

Once you have an ingestion config, you are just about ready to begin streaming data into Sift.

Retrieving Existing Ingestion Configs by ID

To retrieve an existing ingestion config you can use the IngestionConfigService.GetIngestionConfig endpoint by using the ID that was returned in the ingestion config in the response after creation.

Retrieving Existing Ingestion Configs by Client Key

To retrieve an existing ingestion config by client key you can use the IngestionConfigService.ListIngestionConfigs endpoint and providing client_key == "example_client_key" as the filter string.

curl -G -H "Authorization: Bearer $API_TOKEN" -d "filter=client_key=='example_client_key'" $SIFT_REST_URL/api/v1/ingestion-configs

Updating an Ingestion Config

Users may want to add flows after their ingestion config has been created. To add flows to an existing ingestion config users will want to send a CreateIngestionConfigFlowRequest to the IngestionConfigService.