ingest#

Autogenerated API

argus_api.lib.datacollector.v1.ingest.ingest.ingest_bulk_data(category: str, records: dict = None, ignoreOnFailed: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Submit JSON data in bulk that will be forwarded to a Kafka topic based on its category (PUBLIC)

Parameters

  • category (str) – What category the records belong to

  • records (list) – The records containing the JSON data

  • ignoreOnFailed (bool) – Whether or not to ignore any errors in the records (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datacollector.v1.ingest.ingest.ingest_data(category: str, customer: str = None, ignoreOnFailed: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Submit JSON data that will be forwarded to a Kafka topic based on its category (PUBLIC)

Parameters

  • category (str) – What category the records belong to

  • customer (str) – The customer ID or shortname that this data belongs to. Defaults to the current users customer

  • ignoreOnFailed (bool) – Whether or not to ignore any errors in the record

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON