Skip to main content
An ingestion config is created using 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];
}
Field descriptions:
  • asset_name: The name of the Asset to create.
  • flows: More details regarding flows are 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.
Client KeysThe client_key is optional, but providing a value for this field is recommended to make looking up your ingestion configs more convenient.
Once you have an ingestion config, you are almost ready to begin streaming data into Sift. Streaming still requires constructing and sending IngestWithConfigDataStreamRequest messages to IngestService.IngestWithConfigDataStream. Only after those steps does data actually start flowing.

Retrieving existing Ingestion Configs by ID

To retrieve an existing ingestion config you can use the IngestionConfigService.GetIngestionConfig endpoint with 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 provide 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

You might want to add flows after their ingestion config has been created. To add flows to an existing ingestion config, send a CreateIngestionConfigFlowRequest to the IngestionConfigService.