|
4 | 4 | info: |
5 | 5 | title: Cribl API Reference |
6 | 6 | description: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io). |
7 | | - version: 4.16.0-alpha.1763161384714-3f229248 |
| 7 | + version: 4.16.0-alpha.1763717483983-bf4ec3a8 |
8 | 8 | contact: |
9 | 9 | name: Support |
10 | 10 | url: https://portal.support.cribl.io |
@@ -3160,8 +3160,14 @@ components: |
3160 | 3160 | default: manual |
3161 | 3161 | description: Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate |
3162 | 3162 | x-speakeasy-unknown-values: allow |
3163 | | - tokenSecret: {} |
3164 | | - token: {} |
| 3163 | + tokenSecret: |
| 3164 | + type: string |
| 3165 | + title: Token secret (text secret) |
| 3166 | + description: Select or create a stored text secret |
| 3167 | + token: |
| 3168 | + type: string |
| 3169 | + title: Token |
| 3170 | + description: "Shared secret to be provided by any client (Authorization: <token>)" |
3165 | 3171 | enabled: |
3166 | 3172 | type: boolean |
3167 | 3173 | title: Enable token |
@@ -9799,12 +9805,21 @@ components: |
9799 | 9805 | enabled: |
9800 | 9806 | type: boolean |
9801 | 9807 | title: Splunk HEC |
| 9808 | + defaultDataset: |
| 9809 | + type: string |
| 9810 | + allowedIndexesAtToken: |
| 9811 | + type: array |
| 9812 | + items: |
| 9813 | + type: string |
| 9814 | + minLength: 1 |
9802 | 9815 | elasticsearchMetadata: |
9803 | 9816 | type: object |
9804 | 9817 | properties: |
9805 | 9818 | enabled: |
9806 | 9819 | title: Elasticsearch |
9807 | 9820 | type: boolean |
| 9821 | + defaultDataset: |
| 9822 | + type: string |
9808 | 9823 | description: |
9809 | 9824 | type: string |
9810 | 9825 | title: Description |
@@ -14452,10 +14467,29 @@ components: |
14452 | 14467 | - SHA512 |
14453 | 14468 | x-speakeasy-unknown-values: allow |
14454 | 14469 | title: Authentication protocol |
14455 | | - authKey: {} |
| 14470 | + authKey: |
| 14471 | + type: string |
| 14472 | + title: V3 authentication key |
14456 | 14473 | privProtocol: |
14457 | 14474 | default: none |
| 14475 | + enum: |
| 14476 | + - none |
| 14477 | + - des |
| 14478 | + - aes |
| 14479 | + - aes256b |
| 14480 | + - aes256r |
| 14481 | + type: string |
| 14482 | + x-speakeasy-enum-descriptions: |
| 14483 | + - None |
| 14484 | + - DES |
| 14485 | + - AES128 |
| 14486 | + - AES256b (Blumenthal) |
| 14487 | + - AES256r (Reeder) |
| 14488 | + x-speakeasy-unknown-values: allow |
| 14489 | + title: Privacy protocol |
| 14490 | + privKey: |
14458 | 14491 | type: string |
| 14492 | + title: V3 privacy key |
14459 | 14493 | maxBufferSize: |
14460 | 14494 | type: number |
14461 | 14495 | title: Buffer size limit (events) |
@@ -16955,6 +16989,28 @@ components: |
16955 | 16989 | type: string |
16956 | 16990 | title: Value |
16957 | 16991 | description: JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.) |
| 16992 | + queries: |
| 16993 | + type: array |
| 16994 | + title: Queries |
| 16995 | + items: |
| 16996 | + type: object |
| 16997 | + minLength: 1 |
| 16998 | + required: |
| 16999 | + - path |
| 17000 | + - queryExpression |
| 17001 | + properties: |
| 17002 | + path: |
| 17003 | + type: string |
| 17004 | + title: Path |
| 17005 | + description: The Path attribute from the relevant XML Select element |
| 17006 | + queryExpression: |
| 17007 | + type: string |
| 17008 | + title: Query expression |
| 17009 | + description: The XPath query inside the relevant XML Select element |
| 17010 | + xmlQuery: |
| 17011 | + type: string |
| 17012 | + title: XML query |
| 17013 | + description: The XPath query to use for selecting events |
16958 | 17014 | metadata: |
16959 | 17015 | type: array |
16960 | 17016 | title: Fields |
@@ -18146,6 +18202,60 @@ components: |
18146 | 18202 | type: boolean |
18147 | 18203 | title: Enable content |
18148 | 18204 | default: false |
| 18205 | + stateTracking: |
| 18206 | + type: boolean |
| 18207 | + title: State tracking |
| 18208 | + description: Track collection progress between consecutive scheduled executions |
| 18209 | + default: false |
| 18210 | + stateUpdateExpression: |
| 18211 | + type: string |
| 18212 | + title: State update expression |
| 18213 | + description: JavaScript expression that defines how to update the state from an event. Use the event's data and the current state to compute the new state. See [Understanding State Expression Fields](https://docs.cribl.io/stream/collectors-rest#state-tracking-expression-fields) for more information. |
| 18214 | + default: "__timestampExtracted !== false && {latestTime: (state.latestTime || 0) > _time ? state.latestTime : _time}" |
| 18215 | + stateMergeExpression: |
| 18216 | + type: string |
| 18217 | + title: State merge expression |
| 18218 | + description: JavaScript expression that defines which state to keep when merging a task's newly reported state with previously saved state. Evaluates `prevState` and `newState` variables, resolving to the state to keep. |
| 18219 | + default: "prevState.latestTime > newState.latestTime ? prevState : newState" |
| 18220 | + manageState: |
| 18221 | + type: object |
| 18222 | + contentQuery: |
| 18223 | + type: string |
| 18224 | + title: Content query |
| 18225 | + description: "Template for POST body to send with the Collect request. Reference global variables, or functions using template params: `${C.vars.myVar}`, or `${Date.now()}`, `${param}`." |
| 18226 | + cronSchedule: |
| 18227 | + type: string |
| 18228 | + title: Cron schedule |
| 18229 | + description: A cron schedule on which to run this job |
| 18230 | + default: 0 */12 * * * |
| 18231 | + earliest: |
| 18232 | + type: string |
| 18233 | + title: Earliest time |
| 18234 | + default: -12h@h |
| 18235 | + description: "Earliest time, relative to now. Format supported: [+|-]<time_integer><time_unit>@<snap-to_time_unit> (ex: -1hr, -42m, -42m@h)" |
| 18236 | + latest: |
| 18237 | + type: string |
| 18238 | + title: Latest time |
| 18239 | + default: now |
| 18240 | + description: "Latest time, relative to now. Format supported: [+|-]<time_integer><time_unit>@<snap-to_time_unit> (ex: -1hr, -42m, -42m@h)" |
| 18241 | + jobTimeout: |
| 18242 | + title: Job timeout |
| 18243 | + type: string |
| 18244 | + description: "Maximum time the job is allowed to run (examples: 30, 45s, 15m). Units default to seconds if not specified. Enter 0 for unlimited time." |
| 18245 | + pattern: ^\d+[sm]?$ |
| 18246 | + default: "0" |
| 18247 | + logLevel: |
| 18248 | + type: string |
| 18249 | + title: Log level |
| 18250 | + enum: |
| 18251 | + - error |
| 18252 | + - warn |
| 18253 | + - info |
| 18254 | + - debug |
| 18255 | + - silly |
| 18256 | + default: info |
| 18257 | + description: Collector runtime log level |
| 18258 | + x-speakeasy-unknown-values: allow |
18149 | 18259 | requestTimeout: |
18150 | 18260 | type: number |
18151 | 18261 | title: Request timeout (seconds) |
@@ -19306,8 +19416,14 @@ components: |
19306 | 19416 | default: manual |
19307 | 19417 | description: Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate |
19308 | 19418 | x-speakeasy-unknown-values: allow |
19309 | | - tokenSecret: {} |
19310 | | - token: {} |
| 19419 | + tokenSecret: |
| 19420 | + type: string |
| 19421 | + title: Token secret (text secret) |
| 19422 | + description: Select or create a stored text secret |
| 19423 | + token: |
| 19424 | + type: string |
| 19425 | + title: Token |
| 19426 | + description: "Shared secret to be provided by any client (Authorization: <token>)" |
19311 | 19427 | enabled: |
19312 | 19428 | type: boolean |
19313 | 19429 | title: Enable token |
@@ -19654,11 +19770,18 @@ components: |
19654 | 19770 | type: string |
19655 | 19771 | enum: |
19656 | 19772 | - secret |
| 19773 | + - manual |
19657 | 19774 | default: secret |
19658 | 19775 | description: Select Secret to use a text secret to authenticate |
19659 | 19776 | x-speakeasy-unknown-values: allow |
19660 | | - tokenSecret: {} |
19661 | | - token: {} |
| 19777 | + tokenSecret: |
| 19778 | + type: string |
| 19779 | + title: Token secret (text secret) |
| 19780 | + description: Select or create a stored text secret |
| 19781 | + token: |
| 19782 | + type: string |
| 19783 | + title: Token |
| 19784 | + description: "Shared secret to be provided by any client (Authorization: <token>)" |
19662 | 19785 | enabled: |
19663 | 19786 | type: boolean |
19664 | 19787 | title: Enable token |
@@ -22076,6 +22199,15 @@ components: |
22076 | 22199 | default: manual |
22077 | 22200 | description: Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate |
22078 | 22201 | x-speakeasy-unknown-values: allow |
| 22202 | + authToken: |
| 22203 | + type: string |
| 22204 | + title: Auth token |
| 22205 | + description: Shared secret to be provided by any client (in authToken header field). If empty, unauthorized access is permitted. |
| 22206 | + default: "" |
| 22207 | + textSecret: |
| 22208 | + type: string |
| 22209 | + title: Auth token (text secret) |
| 22210 | + description: Select or create a stored text secret |
22079 | 22211 | authType: |
22080 | 22212 | title: Authentication method |
22081 | 22213 | type: string |
|
0 commit comments