ingestion

Create a new ingestion schedule

Changed on
post/api/v1/ingestion/schedules

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Request body

configobject
cron_expressionstring
enabledboolean
ingest_on_queryboolean

IngestOnQuery refreshes the source's catalog in the background after data queries, rate-limited per source.

namestring
plugin_idstring
queryableboolean

Queryable lets agents and users query this source through Marmot; the plugin must support queries.

Response

Created

configobject
created_atstring
created_bystring
cron_expressionstring
enabledboolean
idstring
ingest_on_queryboolean
last_run_atstring
last_run_statusstring
managed_bystring
namestring
next_run_atstring
plugin_idstring
queryableboolean
served_by_idstring
served_by_typestring

ServedByType and ServedByID name the principal whose plugin, running outside Marmot, serves this source's queries; nil when Marmot runs the plugin itself.

updated_atstring

Changes