API DocsRESTIngestion config service

ListIngestionConfigFlows

List ingestion config [flows](/glossary#flow) using an optional filter.

GET
/api/v1/ingestion-configs/{ingestionConfigId}/flows

Path Parameters

ingestionConfigId
Required
string

Query Parameters

pageSizeinteger

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.

Format: "int64"

pageTokenstring

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.

filterstring

A Common Expression Language (CEL) 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. For more information about the fields used for filtering, please refer to this definition. Optional.

curl -X GET "<API_URL>/api/v1/ingestion-configs/string/flows?pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "flows": [
    {
      "name": "string",
      "channels": [
        {
          "name": "string",
          "component": "string",
          "unit": "string",
          "description": "string",
          "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
          "enumTypes": [
            {
              "name": "string",
              "key": 0
            }
          ],
          "bitFieldElements": [
            {
              "name": "string",
              "index": 0,
              "bitCount": 0
            }
          ]
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

Previous

GetIngestionConfig GET

Next

ListIngestionConfigFlows GET