Creates a Ingestor

post

https://api.edgeiq.io/api/v1/platform/ingestors

Ingestors are used to classify ingestors, which represent specific, addressable instances of that class of ingestor.

Body Params

name

string

required

The name of the ingestor.

cloud_ingestor

boolean

Defaults to false

Defines where the ingestor is defined.

listener_type

string

enum

required

The listener type.

listener

object

required

The listener object. Schema depends on the listener_type value (see API Reference)

handler_type

string

enum

required

Defaults to passthrough

The handler type.

Allowed:

handler

object

The handler object. Schema depends on the handler_type value (see API Reference)

translator_id

string

required

The id of the Translator associated with this ingestor.

device_ids

array of strings

The ids of the Devices associated with this ingestor.

device_ids

device_type_ids

array of strings

The ids of the Device Types associated with this ingestor.

device_type_ids

Responses

200

Successful operation

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!