Skip to main content
POST
/
api
/
v1
/
ingestion-configs
CreateIngestionConfig
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/ingestion-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "assetName": "<string>",
  "flows": [
    {
      "name": "<string>",
      "channels": [
        {
          "name": "<string>",
          "component": "<string>",
          "unit": "<string>",
          "description": "<string>",
          "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "enumTypes": [
            {
              "name": "<string>",
              "key": 123,
              "isSigned": true
            }
          ],
          "bitFieldElements": [
            {
              "name": "<string>",
              "index": 123,
              "bitCount": 123
            }
          ]
        }
      ]
    }
  ],
  "organizationId": "<string>",
  "clientKey": "<string>"
}'
{
  "ingestionConfig": {
    "ingestionConfigId": "<string>",
    "assetId": "<string>",
    "clientKey": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to IngestionConfigService_CreateIngestionConfig to create an ingestion configs.

​
assetName
string
required
​
flows
object[]
​
organizationId
string
​
clientKey
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.

Response

A successful response.

The result of a call to IngestionConfigService_CreateIngestionConfig.

​
ingestionConfig
object
required