CreateIngestionConfig

POST

/api/v2/ingestion-configs

Request Body

application/jsonRequired

The request for a call to IngestionConfigService_ListIngestionConfigs to retrieve ingestion configs.

`assetName`
Required
string

`flows`array<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.

curl -X POST "<API_URL>/api/v2/ingestion-configs" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "assetName": "string",
    "flows": [
      {
        "name": "string",
        "channels": [
          {
            "name": "string",
            "unit": "string",
            "description": "string",
            "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
            "enumTypes": [
              {
                "name": "string",
                "key": 0
              }
            ],
            "bitFieldElements": [
              {
                "name": "string",
                "index": 0,
                "bitCount": 0
              }
            ]
          }
        ]
      }
    ],
    "organizationId": "string",
    "clientKey": "string"
  }'

A successful response.

{
  "ingestionConfig": {
    "ingestionConfigId": "string",
    "assetId": "string",
    "clientKey": "string"
  }
}

CreateIngestionConfig

Request Body

assetNameRequiredstring

flowsarray<object>

Object 1

organizationIdstring

clientKeystring

Response

`assetName`
Required
string

`flows`array<object>

`organizationId`string

`clientKey`string