From 19d7a0416fa2561a9b3d9e5c93000514e0bc19c5 Mon Sep 17 00:00:00 2001 From: coralogix-concourse <42734517+coralogix-concourse@users.noreply.github.com> Date: Wed, 26 Aug 2026 09:11:38 +0000 Subject: [PATCH] 4ab5cdd: Sync openapi_v5 from openapi-facade --- .../get-daily-usage-evaluation-tokens.mdx | 3 - .../get-daily-usage-processed-gbs.mdx | 3 - .../get-daily-usage-units.mdx | 3 - .../get-data-usage-metrics-export-status.mdx | 3 - .../v5/data-usage-service/get-data-usage.mdx | 3 - .../v5/data-usage-service/get-logs-count.mdx | 3 - .../v5/data-usage-service/get-spans-count.mdx | 3 - .../v5/data-usage-service/overview.mdx | 187 - ...pdate-data-usage-metrics-export-status.mdx | 3 - .../v5/teams-service/create-team.mdx | 4 + .../v5/teams-service/delete-team.mdx | 4 + api-reference/v5/teams-service/get-team.mdx | 4 + api-reference/v5/teams-service/list-teams.mdx | 4 + .../v5/teams-service/update-team.mdx | 4 + changelog.data.json | 24 +- changelog.mdx | 19 +- docs.json | 14 - openapi_v5.yaml | 17261 +--------------- 18 files changed, 822 insertions(+), 16727 deletions(-) delete mode 100644 api-reference/v5/data-usage-service/get-daily-usage-evaluation-tokens.mdx delete mode 100644 api-reference/v5/data-usage-service/get-daily-usage-processed-gbs.mdx delete mode 100644 api-reference/v5/data-usage-service/get-daily-usage-units.mdx delete mode 100644 api-reference/v5/data-usage-service/get-data-usage-metrics-export-status.mdx delete mode 100644 api-reference/v5/data-usage-service/get-data-usage.mdx delete mode 100644 api-reference/v5/data-usage-service/get-logs-count.mdx delete mode 100644 api-reference/v5/data-usage-service/get-spans-count.mdx delete mode 100644 api-reference/v5/data-usage-service/overview.mdx delete mode 100644 api-reference/v5/data-usage-service/update-data-usage-metrics-export-status.mdx create mode 100644 api-reference/v5/teams-service/create-team.mdx create mode 100644 api-reference/v5/teams-service/delete-team.mdx create mode 100644 api-reference/v5/teams-service/get-team.mdx create mode 100644 api-reference/v5/teams-service/list-teams.mdx create mode 100644 api-reference/v5/teams-service/update-team.mdx diff --git a/api-reference/v5/data-usage-service/get-daily-usage-evaluation-tokens.mdx b/api-reference/v5/data-usage-service/get-daily-usage-evaluation-tokens.mdx deleted file mode 100644 index 32c30ab..0000000 --- a/api-reference/v5/data-usage-service/get-daily-usage-evaluation-tokens.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml post /dataplans/data-usage/v2/daily/evaluation-tokens ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-daily-usage-processed-gbs.mdx b/api-reference/v5/data-usage-service/get-daily-usage-processed-gbs.mdx deleted file mode 100644 index c492dda..0000000 --- a/api-reference/v5/data-usage-service/get-daily-usage-processed-gbs.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml post /dataplans/data-usage/v2/daily/processed-gbs ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-daily-usage-units.mdx b/api-reference/v5/data-usage-service/get-daily-usage-units.mdx deleted file mode 100644 index ca9f939..0000000 --- a/api-reference/v5/data-usage-service/get-daily-usage-units.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml post /dataplans/data-usage/v2/daily/units ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-data-usage-metrics-export-status.mdx b/api-reference/v5/data-usage-service/get-data-usage-metrics-export-status.mdx deleted file mode 100644 index 16a9dc8..0000000 --- a/api-reference/v5/data-usage-service/get-data-usage-metrics-export-status.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml get /dataplans/data-usage/v2/export-status ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-data-usage.mdx b/api-reference/v5/data-usage-service/get-data-usage.mdx deleted file mode 100644 index e48c225..0000000 --- a/api-reference/v5/data-usage-service/get-data-usage.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml get /dataplans/data-usage/v2 ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-logs-count.mdx b/api-reference/v5/data-usage-service/get-logs-count.mdx deleted file mode 100644 index c071314..0000000 --- a/api-reference/v5/data-usage-service/get-logs-count.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml get /dataplans/data-usage/v2/logs/count ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/get-spans-count.mdx b/api-reference/v5/data-usage-service/get-spans-count.mdx deleted file mode 100644 index 4b725e7..0000000 --- a/api-reference/v5/data-usage-service/get-spans-count.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml get /dataplans/data-usage/v2/spans/count ---- \ No newline at end of file diff --git a/api-reference/v5/data-usage-service/overview.mdx b/api-reference/v5/data-usage-service/overview.mdx deleted file mode 100644 index a94583f..0000000 --- a/api-reference/v5/data-usage-service/overview.mdx +++ /dev/null @@ -1,187 +0,0 @@ -# Data Usage Service overview - -A service to manage data usage metrics. - -NB: The `Get logs count`, `Get spans count` and `Get data usage` endpoints return data as a stream of new-line delimited JSON objects. -When you call these endpoints, you must include the `Accept: text/event-stream` header. - -## Common error response codes - -| Status Code | Description | -|-------------|---------------------------------------| -| `400 Bad Request` | Response code 400 | -| `401 Unauthorized` | Response code 401 | -| `500 Internal Server Error` | Response code 500 | - -## Constants - -
- Pillar - - | Value | -|-------| -| `PILLAR_UNSPECIFIED` | -| `PILLAR_METRICS` | -| `PILLAR_LOGS` | -| `PILLAR_SPANS` | -| `PILLAR_BINARY` | -| `PILLAR_PROFILES` | -
-
- TcoTier - - | Value | -|-------| -| `TCO_TIER_UNSPECIFIED` | -| `TCO_TIER_LOW` | -| `TCO_TIER_MEDIUM` | -| `TCO_TIER_HIGH` | -| `TCO_TIER_BLOCKED` | -
-
- Priority - - | Value | -|-------| -| `PRIORITY_UNSPECIFIED` | -| `PRIORITY_LOW` | -| `PRIORITY_MEDIUM` | -| `PRIORITY_HIGH` | -| `PRIORITY_BLOCKED` | -
-
- Severity - - | Value | -|-------| -| `SEVERITY_UNSPECIFIED` | -| `SEVERITY_DEBUG` | -| `SEVERITY_VERBOSE` | -| `SEVERITY_INFO` | -| `SEVERITY_WARNING` | -| `SEVERITY_ERROR` | -| `SEVERITY_CRITICAL` | -
-
- Range - - | Value | -|-------| -| `RANGE_UNSPECIFIED` | -| `RANGE_CURRENT_MONTH` | -| `RANGE_LAST_30_DAYS` | -| `RANGE_LAST_90_DAYS` | -| `RANGE_LAST_WEEK` | -
-
- Resolution - - | Value | -|-------| -| `RESOLUTION_UNSPECIFIED` | -| `RESOLUTION_ONE_MINUTE` | -| `RESOLUTION_FIVE_MINUTES` | -| `RESOLUTION_FIFTEEN_MINUTES` | -| `RESOLUTION_ONE_HOUR` | -| `RESOLUTION_SIX_HOURS` | -| `RESOLUTION_ONE_DAY` | -| `RESOLUTION_ONE_WEEK` | -
-
- GbUnitsRatios - - | Value | -|-------| -| `GB_UNITS_RATIOS_UNSPECIFIED` | -
-
- AggregateBy - - | Value | -|-------| -| `AGGREGATE_BY_UNSPECIFIED` | -| `AGGREGATE_BY_APPLICATION` | -| `AGGREGATE_BY_SUBSYSTEM` | -| `AGGREGATE_BY_PILLAR` | -| `AGGREGATE_BY_PRIORITY` | -
-
- Range - - | Value | -|-------| -| `RANGE_UNSPECIFIED` | -| `RANGE_CURRENT_MONTH` | -| `RANGE_LAST_30_DAYS` | -| `RANGE_LAST_90_DAYS` | -| `RANGE_LAST_WEEK` | -
-
- Pillar - - | Value | -|-------| -| `PILLAR_UNSPECIFIED` | -| `PILLAR_METRICS` | -| `PILLAR_LOGS` | -| `PILLAR_SPANS` | -| `PILLAR_BINARY` | -| `PILLAR_PROFILES` | -
-
- TcoTier - - | Value | -|-------| -| `TCO_TIER_UNSPECIFIED` | -| `TCO_TIER_LOW` | -| `TCO_TIER_MEDIUM` | -| `TCO_TIER_HIGH` | -| `TCO_TIER_BLOCKED` | -
-
- Priority - - | Value | -|-------| -| `PRIORITY_UNSPECIFIED` | -| `PRIORITY_LOW` | -| `PRIORITY_MEDIUM` | -| `PRIORITY_HIGH` | -| `PRIORITY_BLOCKED` | -
-
- Severity - - | Value | -|-------| -| `SEVERITY_UNSPECIFIED` | -| `SEVERITY_DEBUG` | -| `SEVERITY_VERBOSE` | -| `SEVERITY_INFO` | -| `SEVERITY_WARNING` | -| `SEVERITY_ERROR` | -| `SEVERITY_CRITICAL` | -
-
- Range - - | Value | -|-------| -| `RANGE_UNSPECIFIED` | -| `RANGE_CURRENT_MONTH` | -| `RANGE_LAST_30_DAYS` | -| `RANGE_LAST_90_DAYS` | -| `RANGE_LAST_WEEK` | -
-
- Priority - - | Value | -|-------| -| `PRIORITY_UNSPECIFIED` | -| `PRIORITY_LOW` | -| `PRIORITY_MEDIUM` | -| `PRIORITY_HIGH` | -| `PRIORITY_BLOCKED` | -
diff --git a/api-reference/v5/data-usage-service/update-data-usage-metrics-export-status.mdx b/api-reference/v5/data-usage-service/update-data-usage-metrics-export-status.mdx deleted file mode 100644 index 87189ee..0000000 --- a/api-reference/v5/data-usage-service/update-data-usage-metrics-export-status.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: /openapi_v5.yaml post /dataplans/data-usage/v2/export-status ---- \ No newline at end of file diff --git a/api-reference/v5/teams-service/create-team.mdx b/api-reference/v5/teams-service/create-team.mdx new file mode 100644 index 0000000..17cd8fb --- /dev/null +++ b/api-reference/v5/teams-service/create-team.mdx @@ -0,0 +1,4 @@ +--- +openapi: /openapi_v5.yaml post /aaa/teams/v2 +deprecated: true +--- \ No newline at end of file diff --git a/api-reference/v5/teams-service/delete-team.mdx b/api-reference/v5/teams-service/delete-team.mdx new file mode 100644 index 0000000..70439cb --- /dev/null +++ b/api-reference/v5/teams-service/delete-team.mdx @@ -0,0 +1,4 @@ +--- +openapi: /openapi_v5.yaml delete /aaa/teams/v2/{team_id} +deprecated: true +--- \ No newline at end of file diff --git a/api-reference/v5/teams-service/get-team.mdx b/api-reference/v5/teams-service/get-team.mdx new file mode 100644 index 0000000..5fd226d --- /dev/null +++ b/api-reference/v5/teams-service/get-team.mdx @@ -0,0 +1,4 @@ +--- +openapi: /openapi_v5.yaml get /aaa/teams/v2/{team_id} +deprecated: true +--- \ No newline at end of file diff --git a/api-reference/v5/teams-service/list-teams.mdx b/api-reference/v5/teams-service/list-teams.mdx new file mode 100644 index 0000000..f72826e --- /dev/null +++ b/api-reference/v5/teams-service/list-teams.mdx @@ -0,0 +1,4 @@ +--- +openapi: /openapi_v5.yaml get /aaa/teams/v2 +deprecated: true +--- \ No newline at end of file diff --git a/api-reference/v5/teams-service/update-team.mdx b/api-reference/v5/teams-service/update-team.mdx new file mode 100644 index 0000000..5637acc --- /dev/null +++ b/api-reference/v5/teams-service/update-team.mdx @@ -0,0 +1,4 @@ +--- +openapi: /openapi_v5.yaml put /aaa/teams/v2/{team_id} +deprecated: true +--- \ No newline at end of file diff --git a/changelog.data.json b/changelog.data.json index af95a7b..eb81fb2 100644 --- a/changelog.data.json +++ b/changelog.data.json @@ -9,6 +9,7 @@ "0eafd39b6353b8146fb01cab6fc851eb5f4acff4", "122a2e9b8eff5d0ce4640322753e75733167bc4e", "12655f2c4fa683484f5dbb0e2a6f6b4711aa4d73", + "14897332072d9e61b9d4460521c8ad3011da3ad2", "19309168766f9b79d8227052405d22e1e5592d99", "19373893467a53b57601564446c2be134be9a8f8", "1a95ccb48f7fd4ed0b9c55d066be89bf2af8812c", @@ -36,6 +37,7 @@ "5ea3f6cd43752d972722a6d281017417a377a0be", "6173a4c85d920f79d159aed20510b7bc6bf766a3", "62ddf1faf4c87aca981a061a021447623edd9596", + "6314f70b82a2f2d941102299c84df444e272a3cf", "644fb82efa3a4338fab125caab2adeeae07e5043", "64656212d6d95712c1bbbca12b74103e670c011a", "66e355f313f3df7fd4859172cdb9e8ba46d1bea3", @@ -44,6 +46,7 @@ "6cdbe651e334e9f89d10ca288d9554aab5497bfc", "6fb4ee6ea8ea7a0d1499f60631b2f90526ff1782", "75a51432f3af4c9a0bf0a4b76ec4184a3e9bcb4a", + "7651b1216ed5409cb71cb57590f177faf738b98f", "7791c226ceb90fb14be2d89cce9cf59cbc7344ef", "77e0a3169f42e48e0f1945a97061f63058744ca8", "78489db426d9243be32d8e91fa06233978c59b14", @@ -75,12 +78,14 @@ "c3fcc37fd9e8ab8e4720a669a80592a92af7967d", "c4a82831060c300d1d8557c3bfbc1b1c5d546950", "c73aa26644402ae9a0607283d8bb1accf7fc5eee", + "c96d2d6e9d1f4835e8798adc17aceae7a466d85f", "cb1d35c8d83a9cb4b087a4ed8bf49485e2e967ff", "cbce36a1816a50f8b3051cffdabbed789de3c496", "ce35e654127d1cd020911f5f40213fc4af8f696c", "cfd7b94539a082d983fb036006822ba49cea03ab", "d020203e4fd5f1d4007b6ee8b33260bd9122af04", "d34c8c1835494aa50d7cdd422411f72572d4fbdd", + "d8676879ac1cee3659544a2e8d9c2bafbdec7225", "d8c1caef3bba049e413d1e84d8d7775561c62a66", "e4ad568b1831070d68a8daed7db5a0bf82e06cb7", "e51c1c43b1a1854e90c33e8a4f142a7a0f5eaa6d", @@ -96,6 +101,23 @@ "fde094fc67f549a49961396c84a70256ca148e88" ], "releases": [ + { + "release_date": "2026-08-26", + "versions": [], + "upstream_dates": [ + "2026-08-25", + "2026-08-24", + "2026-08-20", + "2026-08-17" + ], + "bullets": [ + "`POST /dataplans/policies/v1`, `PUT /dataplans/log-policies/v1`, `PUT /dataplans/span-policies/v1`, and `PUT /dataplans/rum-policies/v1` now document a `429 Too Many Requests` response, returned when the request would exceed the team's maximum number of policies for that data type (logs, spans, or RUM). The response body is the standard error object (`code`: 429, `message`: string). To resolve it, request a limit increase or reduce the number of policies. This replaces the `400` previously returned for this case on `POST /dataplans/policies/v1` \u2014 **breaking** for callers that key on `400` to detect the limit; the overwrite endpoints previously did not report this condition.", + "Added an `INCIDENT_IO` value to the notification-center `ConnectorType` string enum, which now holds `CONNECTOR_TYPE_UNSPECIFIED`, `SLACK`, `GENERIC_HTTPS`, `PAGERDUTY`, `IBM_EVENT_NOTIFICATIONS`, `SERVICE_NOW`, `EMAIL`, `PAGERDUTY_INCIDENTS`, `MICROSOFT_TEAMS`, `EVENTBRIDGE`, and `INCIDENT_IO`. Non-breaking; additive. The enum is reachable across the notification-center REST API as follows:\n- **Connectors**: the `type` field accepts it in the request and response bodies of `POST /notifications/notification-center/v1/connectors` (create) and `PUT /notifications/notification-center/v1/connectors` (replace); it also appears in the response body of `GET /notifications/notification-center/v1/connectors` (list), `GET /notifications/notification-center/v1/connectors/{id}` (get), and `GET /notifications/notification-center/v1/connectors/all/list` (batch-get). The `connector_type` query parameter on `GET /notifications/notification-center/v1/connectors` also accepts it. The request body's `type` field on `POST /notifications/notification-center/v1/connectors:testConfig` accepts it too.\n- **Connector summaries**: the `type` field appears in the response body of `GET /notifications/notification-center/v1/connectors/all/summaries` and `GET /notifications/notification-center/v1/connectors/list/summaries`; the `connector_type` query parameter on the latter also accepts it.\n- **Connector types**: the `type` field appears in the response body of `GET /notifications/notification-center/v1/connectors/types/summaries`, and both the `type` query parameter and the response body's `type` field on `GET /notifications/notification-center/v1/connector-schemas` accept/return it.\n- **Presets**: the `connectorType` field accepts it in the request body, and appears in the response body, of `POST /notifications/notification-center/v1/presets:createCustom` (create custom) and `PUT /notifications/notification-center/v1/presets:replaceCustom` (replace custom); it also appears in the response body of `GET /notifications/notification-center/v1/presets` (batch-get) and `GET /notifications/notification-center/v1/presets/{id}` (get). The `connector_type` query parameter, and the returned preset summary's `connectorType` field, on `GET /notifications/notification-center/v1/presets/summaries/system` (system default summary), `GET /notifications/notification-center/v1/presets:getDefaultSummary` (default summary), and `GET /notifications/notification-center/v1/presets:summariesList` (list summaries) also accept/return it.", + "Renamed the OpenAPI tag on `POST /dataplan/data-usage/v1/query` and `GET /dataplan/data-usage/v1/capabilities` from `Data Usage Query service` to `Data Usage Query Service`. Docs grouping only; no path, HTTP method, request, or response change. Non-breaking.", + "**Deprecated:** the v2 data usage endpoints are now marked deprecated and are no longer published in the API reference. They continue to be served exactly as before \u2014 no path, HTTP method, request body, response shape, field name, or field type changes, and existing integrations keep working \u2014 but they are no longer documented, and new integrations should not adopt them. The deprecated operations are `GET /dataplans/data-usage/v2`, `GET /dataplans/data-usage/v2/spans/count`, `GET /dataplans/data-usage/v2/logs/count`, `POST /dataplans/data-usage/v2/daily/units`, `POST /dataplans/data-usage/v2/daily/processed-gbs`, `POST /dataplans/data-usage/v2/daily/evaluation-tokens`, and both `GET` and `POST /dataplans/data-usage/v2/export-status`.\n- **Replacement for usage queries:** `POST /dataplan/data-usage/v1/query` (note the singular `dataplan` in the new path) returns billable data usage aggregated into daily or hourly buckets, with filtering and grouping by supported labels. Use `GET /dataplan/data-usage/v1/capabilities` to discover the labels, measurement kinds, units, and per-request limits it accepts before submitting a query. Between them these cover the six usage-reading operations above; the v1 query response is bucket-first and is not shaped like the v2 responses, so callers need to map fields rather than swap the path.\n- **No replacement yet for export status:** `GET` and `POST /dataplans/data-usage/v2/export-status` have no v1 equivalent. They remain available and keep working; callers relying on them should not migrate yet.\n- No removal date is set, and nothing is being switched off by this change.", + "The dashboard API now rejects a spans-query `fieldValue` variable source that has both `observationField` (an object) and `value` (an object) set simultaneously. Both fields live at `dashboard.variablesV2[].source.query.spansQuery.type.fieldValue` in the request bodies. Previously at least one of the two had to be set, and setting both was silently accepted (the extra field ignored); the API now returns a validation error when both are present, so exactly one of the two must be set. The deprecated `value` field (legacy span-field addressing) remains accepted when used alone; `observationField` remains accepted alone and is the preferred field. This is a breaking change for callers that were sending both fields together \u2014 they must drop `value` and send only `observationField`. Affected request bodies: `POST /dashboards/dashboards/v1`, `PUT /dashboards/dashboards/v1`, and `POST /dashboards/check/v1` (which carries the dashboard in the same `dashboard` field); clients can verify the object shapes of both fields from that path in the OpenAPI spec." + ] + }, { "release_date": "2026-08-12", "versions": [ @@ -294,5 +316,5 @@ ] } ], - "last_cx_sha": "v5.0.6" + "last_cx_sha": "c40664f1ae0d3a5d181933ef2abd92745880d53c" } diff --git a/changelog.mdx b/changelog.mdx index 220ce7d..03bf3f8 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -4,6 +4,23 @@ description: "Public API changes, grouped by release version and the date it shi --- + + + - `POST /dataplans/policies/v1`, `PUT /dataplans/log-policies/v1`, `PUT /dataplans/span-policies/v1`, and `PUT /dataplans/rum-policies/v1` now document a `429 Too Many Requests` response, returned when the request would exceed the team's maximum number of policies for that data type (logs, spans, or RUM). The response body is the standard error object (`code`: 429, `message`: string). To resolve it, request a limit increase or reduce the number of policies. This replaces the `400` previously returned for this case on `POST /dataplans/policies/v1` — **breaking** for callers that key on `400` to detect the limit; the overwrite endpoints previously did not report this condition. + - Added an `INCIDENT_IO` value to the notification-center `ConnectorType` string enum, which now holds `CONNECTOR_TYPE_UNSPECIFIED`, `SLACK`, `GENERIC_HTTPS`, `PAGERDUTY`, `IBM_EVENT_NOTIFICATIONS`, `SERVICE_NOW`, `EMAIL`, `PAGERDUTY_INCIDENTS`, `MICROSOFT_TEAMS`, `EVENTBRIDGE`, and `INCIDENT_IO`. Non-breaking; additive. The enum is reachable across the notification-center REST API as follows: + - **Connectors**: the `type` field accepts it in the request and response bodies of `POST /notifications/notification-center/v1/connectors` (create) and `PUT /notifications/notification-center/v1/connectors` (replace); it also appears in the response body of `GET /notifications/notification-center/v1/connectors` (list), `GET /notifications/notification-center/v1/connectors/{id}` (get), and `GET /notifications/notification-center/v1/connectors/all/list` (batch-get). The `connector_type` query parameter on `GET /notifications/notification-center/v1/connectors` also accepts it. The request body's `type` field on `POST /notifications/notification-center/v1/connectors:testConfig` accepts it too. + - **Connector summaries**: the `type` field appears in the response body of `GET /notifications/notification-center/v1/connectors/all/summaries` and `GET /notifications/notification-center/v1/connectors/list/summaries`; the `connector_type` query parameter on the latter also accepts it. + - **Connector types**: the `type` field appears in the response body of `GET /notifications/notification-center/v1/connectors/types/summaries`, and both the `type` query parameter and the response body's `type` field on `GET /notifications/notification-center/v1/connector-schemas` accept/return it. + - **Presets**: the `connectorType` field accepts it in the request body, and appears in the response body, of `POST /notifications/notification-center/v1/presets:createCustom` (create custom) and `PUT /notifications/notification-center/v1/presets:replaceCustom` (replace custom); it also appears in the response body of `GET /notifications/notification-center/v1/presets` (batch-get) and `GET /notifications/notification-center/v1/presets/{id}` (get). The `connector_type` query parameter, and the returned preset summary's `connectorType` field, on `GET /notifications/notification-center/v1/presets/summaries/system` (system default summary), `GET /notifications/notification-center/v1/presets:getDefaultSummary` (default summary), and `GET /notifications/notification-center/v1/presets:summariesList` (list summaries) also accept/return it. + - Renamed the OpenAPI tag on `POST /dataplan/data-usage/v1/query` and `GET /dataplan/data-usage/v1/capabilities` from `Data Usage Query service` to `Data Usage Query Service`. Docs grouping only; no path, HTTP method, request, or response change. Non-breaking. + - **Deprecated:** the v2 data usage endpoints are now marked deprecated and are no longer published in the API reference. They continue to be served exactly as before — no path, HTTP method, request body, response shape, field name, or field type changes, and existing integrations keep working — but they are no longer documented, and new integrations should not adopt them. The deprecated operations are `GET /dataplans/data-usage/v2`, `GET /dataplans/data-usage/v2/spans/count`, `GET /dataplans/data-usage/v2/logs/count`, `POST /dataplans/data-usage/v2/daily/units`, `POST /dataplans/data-usage/v2/daily/processed-gbs`, `POST /dataplans/data-usage/v2/daily/evaluation-tokens`, and both `GET` and `POST /dataplans/data-usage/v2/export-status`. + - **Replacement for usage queries:** `POST /dataplan/data-usage/v1/query` (note the singular `dataplan` in the new path) returns billable data usage aggregated into daily or hourly buckets, with filtering and grouping by supported labels. Use `GET /dataplan/data-usage/v1/capabilities` to discover the labels, measurement kinds, units, and per-request limits it accepts before submitting a query. Between them these cover the six usage-reading operations above; the v1 query response is bucket-first and is not shaped like the v2 responses, so callers need to map fields rather than swap the path. + - **No replacement yet for export status:** `GET` and `POST /dataplans/data-usage/v2/export-status` have no v1 equivalent. They remain available and keep working; callers relying on them should not migrate yet. + - No removal date is set, and nothing is being switched off by this change. + - The dashboard API now rejects a spans-query `fieldValue` variable source that has both `observationField` (an object) and `value` (an object) set simultaneously. Both fields live at `dashboard.variablesV2[].source.query.spansQuery.type.fieldValue` in the request bodies. Previously at least one of the two had to be set, and setting both was silently accepted (the extra field ignored); the API now returns a validation error when both are present, so exactly one of the two must be set. The deprecated `value` field (legacy span-field addressing) remains accepted when used alone; `observationField` remains accepted alone and is the preferred field. This is a breaking change for callers that were sending both fields together — they must drop `value` and send only `observationField`. Affected request bodies: `POST /dashboards/dashboards/v1`, `PUT /dashboards/dashboards/v1`, and `POST /dashboards/check/v1` (which carries the dashboard in the same `dashboard` field); clients can verify the object shapes of both fields from that path in the OpenAPI spec. + + + - Added new comparison values to the alert threshold enums in the alert-definition payload. Non-breaking; additive. The values are reachable across the alerts REST API as follows: @@ -277,4 +294,4 @@ description: "Public API changes, grouped by release version and the date it shi -{/* Generated by build_changelog.py from cx-management-apis@v5.0.6 */} +{/* Generated by build_changelog.py from cx-management-apis@c40664f1ae0d3a5d181933ef2abd92745880d53c */} diff --git a/docs.json b/docs.json index 24064e5..8b252b2 100644 --- a/docs.json +++ b/docs.json @@ -224,20 +224,6 @@ "api-reference/v5/dashboard-service/validate-a-dashboard-and-return-issues" ] }, - { - "group": "Data Usage Service", - "pages": [ - "api-reference/v5/data-usage-service/overview", - "api-reference/v5/data-usage-service/get-daily-usage-evaluation-tokens", - "api-reference/v5/data-usage-service/get-daily-usage-processed-gbs", - "api-reference/v5/data-usage-service/get-daily-usage-units", - "api-reference/v5/data-usage-service/get-data-usage", - "api-reference/v5/data-usage-service/get-data-usage-metrics-export-status", - "api-reference/v5/data-usage-service/get-logs-count", - "api-reference/v5/data-usage-service/get-spans-count", - "api-reference/v5/data-usage-service/update-data-usage-metrics-export-status" - ] - }, { "group": "Enrichments Service", "pages": [ diff --git a/openapi_v5.yaml b/openapi_v5.yaml index c05c0bf..77d0211 100644 --- a/openapi_v5.yaml +++ b/openapi_v5.yaml @@ -2,6 +2,250 @@ openapi: 3.0.0 info: title: '' version: 1.0.0 +tags: + - name: AI Applications Service + description: Manage the catalog of AI applications discovered from spans. + externalDocs: + url: '' + - name: AI Evaluations Service + description: >- + Manage AI evaluations and the custom evaluation catalog for AI + applications. + externalDocs: + url: '' + - name: API Keys Admin Service + description: Administrative operations for API Keys management. + externalDocs: + url: '' + - name: API Keys Service + description: Manage your API Keys. + externalDocs: + url: '' + - name: Actions Service + description: View and manage your Actions. + externalDocs: + url: '' + - name: Alert Scheduler Rule service + description: Manage your alert scheduler rules. + externalDocs: + url: '' + - name: Alert definitions service + description: >- + View and manage your alerts using alert definitions - data structures that + contain the configuration required to create an alert. + externalDocs: + description: Learn more about alerts in our documentation + url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ + - name: Alert events service + description: >- + Get information regarding your alert events - instances of alerts being + triggered. + externalDocs: + description: Learn more about alert events and incidents in our documentation. + url: https://coralogix.com/docs/user-guides/alerting/incidents/ + - name: Case Events service + description: Manage case events, comments, and external thread synchronization. + externalDocs: + url: '' + - name: Case Settings service + description: Manage case settings team configurations. + externalDocs: + url: '' + - name: Cases notification service + description: Track notification adjacent data for cases. + externalDocs: + url: '' + - name: Cases service + description: >- + Manage cases throughout their lifecycle. Create, view, assign, + acknowledge, unacknowledge, resolve, and close cases to streamline + investigations and follow-ups. + externalDocs: + description: Learn more about Cases in our documentation + url: https://coralogix.com/docs/user-guides/cases/ + - name: Connector Schema service + description: Retrieve connector schemas for notification center integrations + externalDocs: + description: Learn more about connectors in our documentation + url: >- + https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ + - name: Connectors service + description: >- + View and manage your connectors - integration instances for notification + destinations + externalDocs: + description: Lean more about connectors in our documentation + url: >- + https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ + - name: Contextual data integration service + description: Query for contextual data integration information. + externalDocs: + url: '' + - name: Custom Enrichments Service + description: Manage your enrichments. + externalDocs: + url: '' + - name: Dashboard folders service + description: Manage your dashboard folders. + externalDocs: + url: '' + - name: Dashboard service + description: Manage your dashboards. + externalDocs: + url: '' + - name: Data Usage Query Service + description: >- + Query billable data usage through the public Coralogix API using daily or + hourly bucketed aggregations over supported labels. + externalDocs: + url: '' + - name: Enrichments Service + description: Manage your enrichments. + externalDocs: + url: '' + - name: Entities service + description: Query information about registered entities in the notification center + externalDocs: + description: Lean more about the notification center in our documentation + url: https://coralogix.com/docs/user-guides/notification-center/introduction/ + - name: Events Service + description: A service for querying events. + externalDocs: + description: Learn more about alerts in our documentation + url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ + - name: Events2Metrics Service + description: Manage your events2metrics. + externalDocs: + url: '' + - name: Extension deployment service + description: A service that enables querying for extension deployment information. + externalDocs: + description: Find out more about extensions in our documentation. + url: https://coralogix.com/docs/integrations/extensions/ + - name: Extension service + description: A service that enables querying for extension information. + externalDocs: + description: Learn more about extensions in our documentation. + url: https://coralogix.com/docs/integrations/extensions/ + - name: Folders for views service + description: Create and manage view folders. + externalDocs: + url: '' + - name: Global routers service + description: >- + View and manage your global routers - entities that direct notifications + to configured destinations based on conditions + externalDocs: + description: Lean more about global routers in our documentation + url: >- + https://coralogix.com/docs/user-guides/notification-center/routing/introduction/ + - name: IP access service + description: >- + IP access service provides the API for managing company IP access + settings. + externalDocs: + url: '' + - name: Incidents service + description: >- + Handle all operations related to incident management within Coralogix. + Identify, manage, and resolve incidents efficiently through automated + workflows and team collaboration. + externalDocs: + description: Find out more about incident management in our documentation + url: https://coralogix.com/docs/user-guides/alerting/incidents/ + - name: Integration service + description: A service that enables querying for integration information. + externalDocs: + description: Find out more about integrations in our documentation. + url: https://coralogix.com/docs/integrations/getting-started/ + - name: Metrics Data Archive Service + description: View and manage your storage targets for metrics. + externalDocs: + description: Find out more about archives + url: >- + https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ + - name: Notifications testing service + description: >- + Test your notification center configurations including connectors, + presets, and templates + externalDocs: + description: Lean more about the notification center in our documentation + url: https://coralogix.com/docs/user-guides/notification-center/introduction/ + - name: Outgoing webhooks service + externalDocs: + description: Find out more about outbound webhooks in our documentation. + url: >- + https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/ + - name: Policies Service + description: View and manage your TCO policies + externalDocs: + url: '' + - name: Presets service + description: >- + View and manage your presets - pre-configured templates for notification + content rendering + externalDocs: + description: Lean more about presets in our documentation + url: >- + https://coralogix.com/docs/user-guides/notification-center/presets/introduction/ + - name: Quota Allocation Rule Set service + description: Manage quota allocation rules for different entity types. + externalDocs: + url: '' + - name: Recording Rules Service + description: A service to manage recording rules. + externalDocs: + url: '' + - name: Retentions Service + description: View and manage retentions + externalDocs: + url: '' + - name: Role Management Service + description: Service for managing system and custom roles. + externalDocs: + url: '' + - name: Rule Groups Service + description: A service to manage rule groups. + externalDocs: + url: '' + - name: SAML Configuration Service + description: Manage your SAML configuration + externalDocs: + url: '' + - name: Scopes Service + description: A service to manage scopes + externalDocs: + url: '' + - name: Slos Service + description: A service for managing Service Level Objectives (SLOs). + externalDocs: + url: '' + - name: Target Service + description: View and manage your storage targets for logs. + externalDocs: + description: Find out more about archives + url: >- + https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ + - name: Team Groups Management Service + description: Manage Team Groups. + externalDocs: + url: '' + - name: Teams Service + description: >- + Deprecated. Read and manage the teams in an organization and the daily + quota assigned to each of them. + externalDocs: + url: '' + - name: Users Management Service + description: >- + Manage team members (users) including creation, updates, search, and + status management. + externalDocs: + url: '' + - name: Views service + description: Create and manage views. + externalDocs: + url: '' paths: /aaa/api-keys/v3: get: @@ -1863,6 +2107,308 @@ paths: summary: Delete company IP access settings tags: - IP access service + /aaa/teams/v2: + get: + deprecated: true + description: >- + Deprecated. Returns every team in the calling user's organization, + together with the organization's default team. + externalDocs: + url: '' + operationId: TeamService_ListTeams + responses: + '200': + content: + application/json: + example: + defaultTeam: + dailyQuota: 10 + retention: 30 + teamId: + id: 1001 + teamName: Default + teams: + - dailyQuota: 10 + retention: 30 + teamId: + id: 1001 + teamName: Default + - dailyQuota: 2.5 + retention: 7 + teamId: + id: 1002 + teamName: Platform + schema: + $ref: '#/components/schemas/ListTeamsResponse' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized request + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: List teams + tags: + - Teams Service + post: + deprecated: true + description: >- + Deprecated. Creates a team in the calling user's organization and + returns its identifier. + externalDocs: + url: '' + operationId: TeamService_CreateTeamInOrg + requestBody: + content: + application/json: + schema: + description: Request to create a team in the calling user's organization. + properties: + dailyQuota: + description: >- + Daily quota to assign to the new team, in quota units per + day. Defaults to 0.01 when omitted. + format: double + type: number + teamAdminsEmail: + description: >- + Email addresses of the users to add to the new team as + administrators. + items: + description: >- + Email addresses of the users to add to the new team as + administrators. + maxLength: 320 + minLength: 1 + pattern: ^[^@\s]+@[^@\s]+$ + type: string + maxItems: 100 + minItems: 0 + type: array + teamName: + description: Display name of the team to create. + maxLength: 255 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + required: + - teamName + type: object + required: true + responses: + '200': + content: + application/json: + example: + teamId: + id: 1002 + schema: + $ref: '#/components/schemas/CreateTeamInOrgResponse' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized request + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: A team with the same name already exists + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Create team + tags: + - Teams Service + /aaa/teams/v2/{team_id}: + get: + deprecated: true + description: Deprecated. Returns a single team by its identifier. + externalDocs: + url: '' + operationId: TeamService_GetTeam + responses: + '200': + content: + application/json: + example: + dailyQuota: 2.5 + retention: 7 + teamId: + id: 1002 + teamName: Platform + schema: + $ref: '#/components/schemas/GetTeamResponse' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Team not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Get team + tags: + - Teams Service + put: + deprecated: true + description: Deprecated. Updates a team. + externalDocs: + url: '' + operationId: TeamService_UpdateTeam + requestBody: + content: + application/json: + schema: + description: >- + Request to update a team. Omitted optional fields keep their + existing values. + properties: + dailyQuota: + description: >- + New daily quota for the team, in quota units per day. Omit + to keep the current quota. + format: double + type: number + teamName: + description: >- + New display name for the team. Omit to keep the current + name. + maxLength: 255 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + type: object + responses: + '200': + content: + application/json: + example: {} + schema: + $ref: '#/components/schemas/UpdateTeamResponse' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Team not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Update team + tags: + - Teams Service + delete: + deprecated: true + description: >- + Deprecated. Deletes a team and releases its daily quota back to the + organization. + externalDocs: + url: '' + operationId: TeamService_DeleteTeam + responses: + '200': + content: + application/json: + example: {} + schema: + $ref: '#/components/schemas/DeleteTeamResponse' + description: '' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Bad Request + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Unauthorized request + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Team not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + summary: Delete team + tags: + - Teams Service + parameters: + - name: team_id + in: path + description: Unique team identifier. + required: true + schema: + maximum: 4294967295 + minimum: 0 + type: integer + description: Unique team identifier. + format: int64 /aaa/teams/v2/{team_id}/members: put: description: Updates team members for the specified team. @@ -9339,7 +9885,7 @@ paths: description: '' summary: Get data usage capabilities tags: - - Data Usage Query service + - Data Usage Query Service x-coralogixPermissions: - data-usage:Read /dataplan/data-usage/v1/query: @@ -9442,7 +9988,7 @@ paths: description: '' summary: Query data usage tags: - - Data Usage Query service + - Data Usage Query Service x-coralogixPermissions: - data-usage:Read /dataplan/quota-rules/v1: @@ -9661,670 +10207,6 @@ paths: - Quota Allocation Rule Set service x-coralogixPermissions: - team-quota-rules:Manage - /dataplans/data-usage/v2: - get: - description: Returns data usage summary for the team. - externalDocs: - url: '' - operationId: DataUsageService_GetDataUsage - parameters: - - description: Date interval to query data usage over. - in: query - name: date_range - required: false - schema: - description: This data structure represents a date range. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - fromDate: - description: The from date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - toDate: - description: The to date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - title: Date Range - type: object - - description: >- - Aggregation resolution. Minimum supported value is 1h. Must be - between 1 hour and the date_range interval. - in: query - name: resolution - required: false - schema: - description: >- - Aggregation resolution. Minimum supported value is 1h. Must be - between 1 hour and the date_range interval. - minLength: 0 - type: string - - description: >- - List of fields to aggregate results by (for example pillar and - priority). - in: query - name: aggregate - required: false - schema: - description: >- - List of fields to aggregate results by (for example pillar and - priority). - items: - $ref: '#/components/schemas/AggregateBy' - minItems: 0 - type: array - - description: >- - Dimensions to filter results by; only entries that contain all - listed dimensions are returned. - in: query - name: dimension_filters - required: false - schema: - description: >- - Dimensions to filter results by; only entries that contain all - listed dimensions are returned. - items: - oneOf: - - required: - - pillar - type: object - - required: - - genericDimension - type: object - - required: - - tier - type: object - - required: - - severity - type: object - - required: - - priority - type: object - - not: - anyOf: - - required: - - pillar - type: object - - required: - - genericDimension - type: object - - required: - - tier - type: object - - required: - - severity - type: object - - required: - - priority - type: object - type: object - properties: - genericDimension: - description: This data structure represents a generic dimension. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - key: - description: The key. - example: key - minLength: 0 - type: string - value: - description: The value. - example: value - minLength: 0 - type: string - title: Generic Dimension - type: object - pillar: - $ref: '#/components/schemas/v2.Pillar' - priority: - $ref: '#/components/schemas/v2.Priority' - severity: - $ref: '#/components/schemas/datausage.v2.Severity' - tier: - allOf: - - $ref: '#/components/schemas/v2.TcoTier' - deprecated: true - type: object - minItems: 0 - type: array - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetDataUsageResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Data Usage - tags: - - Data Usage Service - /dataplans/data-usage/v2/daily/evaluation-tokens: - post: - description: Returns daily evaluation token usage data for the specified period. - externalDocs: - url: '' - operationId: DataUsageService_GetDailyUsageEvaluationTokens - requestBody: - content: - application/json: - schema: - description: >- - Request for daily evaluation token usage data for the specified - period. - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetDailyUsageEvaluationTokensResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Daily Usage Evaluation Tokens - tags: - - Data Usage Service - /dataplans/data-usage/v2/daily/processed-gbs: - post: - description: Returns daily processed gigabytes usage data for the specified period. - externalDocs: - url: '' - operationId: DataUsageService_GetDailyUsageProcessedGbs - requestBody: - content: - application/json: - schema: - description: >- - Request for daily processed gigabytes usage data for the - specified period. - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetDailyUsageProcessedGbsResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Daily Usage Processed GBs - tags: - - Data Usage Service - /dataplans/data-usage/v2/daily/units: - post: - description: Returns daily units usage data for the specified period. - externalDocs: - url: '' - operationId: DataUsageService_GetDailyUsageUnits - requestBody: - content: - application/json: - schema: - description: Request for daily units usage data for the specified period. - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetDailyUsageUnitsResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Daily Usage Units - tags: - - Data Usage Service - /dataplans/data-usage/v2/export-status: - get: - description: Returns the current export status for data usage. - externalDocs: - url: '' - operationId: DataUsageService_GetDataUsageMetricsExportStatus - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetDataUsageMetricsExportStatusResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Data Usage Metrics Export Status - tags: - - Data Usage Service - post: - description: Triggers a data usage export. - externalDocs: - url: '' - operationId: DataUsageService_UpdateDataUsageMetricsExportStatus - requestBody: - content: - application/json: - schema: - description: >- - This data structure is used to update data usage metrics export - status. - properties: - enabled: - description: Whether this resource is enabled. - example: true - type: boolean - title: Update Data Usage Metrics Export Status Request - type: object - responses: - '200': - content: - application/json: - schema: - $ref: >- - #/components/schemas/UpdateDataUsageMetricsExportStatusResponse - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Update Data Usage Metrics Export Status - tags: - - Data Usage Service - /dataplans/data-usage/v2/logs/count: - get: - description: Returns the log ingestion count for the team. - externalDocs: - url: '' - operationId: DataUsageService_GetLogsCount - parameters: - - description: Date interval to query log ingestion counts over. - in: query - name: date_range - required: false - schema: - description: This data structure represents a date range. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - fromDate: - description: The from date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - toDate: - description: The to date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - title: Date Range - type: object - - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - in: query - name: resolution - required: false - schema: - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - minLength: 0 - type: string - - description: >- - Optional scope filter that restricts results to the listed - applications and subsystems (full match). - in: query - name: filters - required: false - schema: - description: This data structure represents a filter for scopes. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - application: - description: List of application names to filter on (OR logic, full match). - items: - description: >- - List of application names to filter on (OR logic, full - match). - example: application1 - minLength: 0 - type: string - minItems: 0 - type: array - subsystem: - description: List of subsystem names to filter on (OR logic, full match). - items: - description: List of subsystem names to filter on (OR logic, full match). - example: subsystem1 - minLength: 0 - type: string - minItems: 0 - type: array - title: Scopes Filter - type: object - - description: When true, aggregate the returned counts by subsystem name. - in: query - name: subsystem_aggregation - required: false - schema: - description: When true, aggregate the returned counts by subsystem name. - type: boolean - - description: When true, aggregate the returned counts by application name. - in: query - name: application_aggregation - required: false - schema: - description: When true, aggregate the returned counts by application name. - type: boolean - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogsCountResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Logs Count - tags: - - Data Usage Service - /dataplans/data-usage/v2/spans/count: - get: - description: Returns the span ingestion count for the team. - externalDocs: - url: '' - operationId: DataUsageService_GetSpansCount - parameters: - - description: Date interval to query span ingestion counts over. - in: query - name: date_range - required: false - schema: - description: This data structure represents a date range. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - fromDate: - description: The from date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - toDate: - description: The to date. - example: '2021-01-01T00:00:00.000Z' - format: date-time - minLength: 0 - type: string - title: Date Range - type: object - - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - in: query - name: resolution - required: false - schema: - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - minLength: 0 - type: string - - description: >- - Optional scope filter that restricts results to the listed - applications and subsystems (full match). - in: query - name: filters - required: false - schema: - description: This data structure represents a filter for scopes. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - properties: - application: - description: List of application names to filter on (OR logic, full match). - items: - description: >- - List of application names to filter on (OR logic, full - match). - example: application1 - minLength: 0 - type: string - minItems: 0 - type: array - subsystem: - description: List of subsystem names to filter on (OR logic, full match). - items: - description: List of subsystem names to filter on (OR logic, full match). - example: subsystem1 - minLength: 0 - type: string - minItems: 0 - type: array - title: Scopes Filter - type: object - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/GetSpansCountResponse' - description: '' - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Bad Request - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Unauthorized request - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - description: Internal server error - summary: Get Spans Count - tags: - - Data Usage Service /dataplans/log-policies/v1: put: description: Updates the log data retention policies. @@ -10370,6 +10252,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Unauthorized request + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: >- + Policy limit exceeded. Request a limit increase or reduce the number + of policies. '500': content: application/json: @@ -10668,6 +10558,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Unauthorized request + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: >- + Policy limit exceeded. Request a limit increase or reduce the number + of policies. '500': content: application/json: @@ -11138,6 +11036,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Unauthorized request + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: >- + Policy limit exceeded. Request a limit increase or reduce the number + of policies. '500': content: application/json: @@ -11194,6 +11100,14 @@ paths: schema: $ref: '#/components/schemas/Error' description: Unauthorized request + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: >- + Policy limit exceeded. Request a limit increase or reduce the number + of policies. '500': content: application/json: @@ -12213,7 +12127,26 @@ paths: metaLabels: description: Filters all incidents with the given meta labels items: - $ref: '#/components/schemas/incidents.v1.MetaLabel' + description: Meta label. + externalDocs: + url: '' + properties: + key: + description: The key. + example: key + maxLength: 255 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + value: + description: The value. + example: value + maxLength: 255 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + title: Incident meta label + type: object maxItems: 1000 minItems: 0 type: array @@ -12222,9 +12155,39 @@ paths: - $ref: '#/components/schemas/v1.FilterOperator' description: The operator for the meta labels filter searchQuery: - allOf: - - $ref: '#/components/schemas/IncidentSearchQuery' - description: Search query for incidents + description: Incident search query. + externalDocs: + url: '' + oneOf: + - required: + - incidentField + type: object + - required: + - contextualLabel + type: object + properties: + contextualLabel: + description: The contextual label to search in. + maxLength: 256 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + incidentField: + allOf: + - $ref: '#/components/schemas/IncidentFields' + description: The field to search in + example: INCIDENTS_FIELDS_STATUS + query: + description: The search query + example: error + maxLength: 4096 + minLength: 1 + pattern: ^[\s\S]*$ + type: string + required: + - query + title: Incident search query + type: object severity: description: Filter by incident severity items: @@ -18970,14 +18933,6 @@ components: our documentation url: >- https://coralogix.com/docs/integrations/azure/azure-resource-manager-integration-packages/ - AccessEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/AlertDefAccess' AccessPolicyAction: title: Access policy action type: object @@ -19059,25 +19014,6 @@ components: propertyName: accessType externalDocs: url: '' - AcknowledgeCaseRequest: - title: Acknowledge case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to acknowledge. Accepts either the case UUID (the - `id` field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' AcknowledgeCaseResponse: title: Acknowledge case response required: @@ -19091,22 +19027,6 @@ components: description: Response containing the case after it has been acknowledged. externalDocs: url: '' - AcknowledgeIncidentByEventIdRequest: - title: Acknowledge incident by event id request - required: - - eventId - type: object - properties: - eventId: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Event ID associated to the Incident to acknowledge - example: event_id_1 - description: Request to acknowledge incident - externalDocs: - url: '' AcknowledgeIncidentByEventIdResponse: title: Acknowledge incident by event id response required: @@ -19120,30 +19040,6 @@ components: description: Response containing the updated incident after acknowledgment externalDocs: url: '' - AcknowledgeIncidentsRequest: - title: Acknowledge incidents request - required: - - incidentIds - type: object - properties: - incidentIds: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of incident IDs to acknowledge - description: List of incident IDs to acknowledge - example: - - 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - - 9c858901-8a57-4791-81fe-4c455b099bc9 - description: Request to acknowledge one or more incidents - externalDocs: - url: '' AcknowledgeIncidentsResponse: title: Acknowledge incidents response required: @@ -19273,9 +19169,6 @@ components: request. externalDocs: url: '' - ActivateRetentionsRequest: - type: object - additionalProperties: false ActivateRetentionsResponse: title: Activate Retentions Response type: object @@ -19407,73 +19300,6 @@ components: time windows externalDocs: url: '' - AdaptiveRule: - type: object - properties: - enabled: - type: boolean - state: - $ref: '#/components/schemas/AdaptiveRuleState' - updatedAt: - minLength: 0 - type: string - format: date-time - AdaptiveRuleState: - enum: - - ADAPTIVE_RULE_STATE_UNSPECIFIED - - ADAPTIVE_RULE_STATE_MEDIUM - - ADAPTIVE_RULE_STATE_LOW - - ADAPTIVE_RULE_STATE_BLOCKED - type: string - AdaptiveRuleUpdate: - type: object - properties: - enabled: - type: boolean - state: - $ref: '#/components/schemas/AdaptiveRuleState' - AdaptiveRules: - type: object - properties: - adHocOnly: - $ref: '#/components/schemas/AdaptiveRule' - bogus: - $ref: '#/components/schemas/AdaptiveRule' - brokenQueriesOnly: - $ref: '#/components/schemas/AdaptiveRule' - unused: - $ref: '#/components/schemas/AdaptiveRule' - AdaptiveRulesUpdate: - type: object - properties: - adHocOnly: - $ref: '#/components/schemas/AdaptiveRuleUpdate' - bogus: - $ref: '#/components/schemas/AdaptiveRuleUpdate' - brokenQueriesOnly: - $ref: '#/components/schemas/AdaptiveRuleUpdate' - unused: - $ref: '#/components/schemas/AdaptiveRuleUpdate' - AddEnrichmentsRequest: - title: Enrichments Creation Request - required: - - requestEnrichments - type: object - properties: - requestEnrichments: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EnrichmentRequestModel' - description: >- - The request enrichments. The total number of enrichment rules is - limited by the account's enrichment limit (5 by default). - description: This response data structure represents a collection of enrichments - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ AddEnrichmentsResponse: title: Encrichments Creation Response required: @@ -19492,54 +19318,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - AgentSelectorRequest: - type: object - properties: - attributes: - type: object - additionalProperties: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: >- - Flat agent attributes to match. If collectorVersion is set, - service.version must match it or is added automatically. - description: Agent selector used in requests. - externalDocs: - url: '' - AgentSelectorRequest.AttributesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - AgentSelectorResponse: - type: object - properties: - attributes: - type: object - additionalProperties: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Flat agent attributes matched by the selector. - description: Agent selector returned in responses. - externalDocs: - url: '' - AgentSelectorResponse.AttributesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string AggType: enum: - AGG_TYPE_UNSPECIFIED @@ -19552,25 +19330,6 @@ components: - AGG_TYPE_SAMPLES type: string description: Agg type. - AggregateBy: - enum: - - AGGREGATE_BY_UNSPECIFIED - - AGGREGATE_BY_APPLICATION - - AGGREGATE_BY_SUBSYSTEM - - AGGREGATE_BY_PILLAR - - AGGREGATE_BY_PRIORITY - - AGGREGATE_BY_POLICY_NAME - - AGGREGATE_BY_SEVERITY - type: string - AggregationType: - enum: - - AGGREGATION_TYPE_UNSPECIFIED - - AGGREGATION_TYPE_AVG - - AGGREGATION_TYPE_MIN - - AGGREGATION_TYPE_MAX - - AGGREGATION_TYPE_SUM - - AGGREGATION_TYPE_COUNT - type: string AiApplication: type: object properties: @@ -19617,25 +19376,6 @@ components: description: AI Application externalDocs: url: '' - AiCenterProduct: - enum: - - AI_CENTER_PRODUCT_UNSPECIFIED - - CLAUDE_CODE - - GITHUB_COPILOT - - CURSOR - - CODEX - - OPENCLAW - - OPENCODE - - CLAUDE_AI - - CHATGPT - type: string - description: >- - The AI product whose usage data reaches Coralogix. The AI Center Code - Agents view tracks these together, so the set spans coding agents and - the chat products of the same vendors - CLAUDE_AI alongside CLAUDE_CODE, - CHATGPT alongside CODEX - because a team adopting one usually adopts the - other and both arrive through the same vendor integrations. New values - are added over time; clients must tolerate values they do not recognize. AiEvaluation: type: object properties: @@ -19825,15 +19565,6 @@ components: description: Filter by alert definition entity labels externalDocs: url: '' - AlertDefEntityLabelsFilter.EntityLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string AlertDefIdFilter: title: AlertDef ID Filter type: object @@ -19971,25 +19702,6 @@ components: description: Alert def notification group. externalDocs: url: '' - AlertDefOrderBy: - title: Alert definition order by - type: object - properties: - direction: - allOf: - - $ref: '#/components/schemas/AlertDefOrderByDirection' - description: Direction for ordering - example: ALERT_DEF_ORDER_BY_DIRECTION_DESC - fieldName: - allOf: - - $ref: '#/components/schemas/AlertDefOrderByFields' - description: Field name to order by - example: ALERT_DEF_ORDER_BY_FIELDS_UPDATED_TIME - description: >- - A data structure that specifies the field and direction for ordering - alert definitions - externalDocs: - url: '' AlertDefOrderByDirection: enum: - ALERT_DEF_ORDER_BY_DIRECTION_ASC_OR_UNSPECIFIED @@ -20005,20 +19717,6 @@ components: - ALERT_DEF_ORDER_BY_FIELDS_ENABLED type: string description: Alert def order by fields. - AlertDefOrderByList: - title: Alert definition order by list - type: object - properties: - orderBys: - maxItems: 20 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/AlertDefOrderBy' - description: Order by fields for alert definitions - description: List of fields to order alert definitions by - externalDocs: - url: '' AlertDefOverride: title: Alert definition priority update type: object @@ -20335,78 +20033,6 @@ components: description: User-configurable properties of an alert definition externalDocs: url: '' - AlertDefProperties.EntityLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - AlertDefQueryFilter: - title: AlertDef query filter - type: object - properties: - enabledFilter: - allOf: - - $ref: '#/components/schemas/AlertDefEnabledFilter' - description: Filter by AlertDef enabled status - entityLabelsFilter: - allOf: - - $ref: '#/components/schemas/AlertDefEntityLabelsFilter' - description: Filter by AlertDef entity labels - idFilter: - allOf: - - $ref: '#/components/schemas/AlertDefIdFilter' - description: Filter by alert definition IDs to include or exclude - lastTriggeredTimeRangeFilter: - allOf: - - $ref: '#/components/schemas/AlertDefLastTriggeredTimeFilter' - description: Filters all alerts that were triggered at the given time range - modifiedTimeRangeFilter: - allOf: - - $ref: '#/components/schemas/AlertDefModifiedTimeFilter' - description: Filters all alerts that were modified at the given time range - nameFilter: - allOf: - - $ref: '#/components/schemas/AlertDefNameFilter' - description: Filter by name - priorityFilter: - allOf: - - $ref: '#/components/schemas/AlertDefPriorityFilter' - description: Filter by AlertDef priority - statusFilter: - allOf: - - $ref: '#/components/schemas/AlertDefStatusFilter' - description: Filter by alert definition status - typeFilter: - allOf: - - $ref: '#/components/schemas/AlertDefTypeFilter' - description: Filter by AlertDef type - typeSpecificFilter: - allOf: - - $ref: '#/components/schemas/AlertDefTypeSpecificFilter' - description: Filter by fields specific to alert type definitions - description: Filter configuration for alert defs - externalDocs: - url: '' - AlertDefSeverity: - title: Alert definition severity - type: object - properties: - priority: - allOf: - - $ref: '#/components/schemas/AlertDefPriority' - description: The priority of the alert definition - example: ALERT_DEF_PRIORITY_P3 - severity: - type: integer - format: int32 - example: 3 - description: Defines the severity level and priority of an alert - externalDocs: - url: '' AlertDefSloSpecificFilter: title: AlertDef SLO Specific Filter type: object @@ -20589,14 +20215,6 @@ components: indicator. externalDocs: url: '' - AlertDefsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/AlertDef' AlertEvent: title: Alert event type: object @@ -20662,24 +20280,6 @@ components: description: Alert event. externalDocs: url: '' - AlertEvent.GroupLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - AlertEvent.PermutationLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string AlertEventMultiplePermutation: type: object properties: @@ -20693,38 +20293,6 @@ components: description: Alert event multiple permutation. externalDocs: url: '' - AlertEventOrderBy: - type: object - properties: - direction: - $ref: '#/components/schemas/OrderByAlertEventDirection' - fieldName: - $ref: '#/components/schemas/OrderByAlertEventFields' - AlertEventOut: - type: object - properties: - alertId: - minLength: 0 - type: string - eventId: - minLength: 0 - type: string - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - AlertEventPayload: - type: object - properties: - payload: - type: object - payloadType: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The payload type. AlertFilters: title: Alert filters type: object @@ -21000,47 +20568,6 @@ components: description: Deep links derived from a single alert indicator on a case. externalDocs: url: '' - AlertIndicatorsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/AlertIndicatorDeepLink' - AlertNotificationEvent: - title: Alert notification event - type: object - properties: - attachments: - allOf: - - $ref: '#/components/schemas/Attachments' - description: The attachments. - groupingKey: - minLength: 0 - type: string - groups: - type: object - additionalProperties: - $ref: '#/components/schemas/v3.Group' - description: Groups. - highestPriority: - $ref: '#/components/schemas/v3.Priority' - id: - minLength: 0 - type: string - description: Unique identifier. - status: - allOf: - - $ref: '#/components/schemas/AlertStatus' - description: Status. - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - externalDocs: - url: '' AlertSchedulerRule: type: object properties: @@ -21084,34 +20611,6 @@ components: description: Alert scheduler rule. externalDocs: url: '' - AlertSchedulerRuleIds: - type: object - properties: - alertSchedulerRuleIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of alert scheduler rule IDs. - description: List of alert scheduler rule IDs. - description: Alert scheduler rule ids. - externalDocs: - url: '' - AlertSchedulerRuleVersionIds: - type: object - properties: - alertSchedulerRuleVersionIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The alert scheduler rule version ids. - description: The alert scheduler rule version ids. - description: Alert scheduler rule version ids. - externalDocs: - url: '' AlertSchedulerRuleWithActiveTimeframe: type: object properties: @@ -21240,17 +20739,6 @@ components: description: Allow parameters. externalDocs: url: '' - AllowRequest: - type: object - properties: - ruleIds: - minItems: 0 - type: array - items: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string AllowedLoginMode: enum: - ALLOWED_LOGIN_MODE_UNSPECIFIED @@ -21280,24 +20768,6 @@ components: description: Always. externalDocs: url: '' - AnalysisResult: - type: object - properties: - cardinality: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - sampleCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - timeSeries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/metric_explore.TimeSeries' AnalyticsImmediateType: title: Analytics immediate alert type type: object @@ -21587,113 +21057,12 @@ components: - ANNOTATION_COLOR_YELLOW type: string description: Annotation color. - AnnotationEvent: - type: object - oneOf: - - required: - - instant - type: object - - required: - - range - type: object - - type: object - not: - anyOf: - - required: - - instant - type: object - - required: - - range - type: object - properties: - instant: - $ref: '#/components/schemas/AnnotationEvent.Instant' - range: - $ref: '#/components/schemas/AnnotationEvent.Range' - AnnotationEvent.Instant: - type: object - properties: - labels: - type: object - additionalProperties: - minLength: 0 - type: string - description: Labels. - payload: - type: object - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - description: Dataprime source.strategy.instant. - externalDocs: - url: '' - AnnotationEvent.Range: - type: object - properties: - end: - minLength: 0 - type: string - format: date-time - labels: - type: object - additionalProperties: - minLength: 0 - type: string - payload: - type: object - start: - minLength: 0 - type: string - format: date-time - description: Range. - externalDocs: - url: '' AnnotationOrientation: enum: - ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED - ANNOTATION_ORIENTATION_HORIZONTAL type: string description: Annotation orientation. - AnnotationSeriesVisibility: - title: AnnotationSeriesVisibility - required: - - annotationId - - visibility - type: object - properties: - annotationId: - minLength: 0 - type: string - description: Unique identifier of the annotation - seriesNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: 'When visibility is SHOW_ONLY: list of series names to display' - description: 'When visibility is SHOW_ONLY: list of series names to display' - example: - - staging - - production - visibility: - allOf: - - $ref: '#/components/schemas/SeriesVisibilityMode' - description: Visibility mode for the annotation series - description: Annotation series visibility config - externalDocs: - url: '' - AnnotationsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string AnomalyAlertSettings: title: Anomaly alert settings type: object @@ -22061,57 +21430,6 @@ components: description: Definition of an APM-based SLI with automatic query generation externalDocs: url: '' - ApmSlo: - type: object - properties: - slo: - $ref: '#/components/schemas/Slo' - ApmSloInput: - type: object - properties: - apmSli: - $ref: '#/components/schemas/ApmSli' - description: - minLength: 0 - type: string - description: Human-readable description. - labels: - type: object - additionalProperties: - minLength: 0 - type: string - name: - minLength: 0 - type: string - description: Display name. - ownershipTags: - $ref: '#/components/schemas/SloOwnershipTags' - sloTimeFrame: - $ref: '#/components/schemas/SloTimeFrame' - targetThresholdPercentage: - type: number - format: float - ApmSloInput.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - ApmSloType: - enum: - - APM_SLO_TYPE_UNSPECIFIED - - APM_SLO_TYPE_ERROR - - APM_SLO_TYPE_LATENCY - type: string - ApmSource: - enum: - - APM_SOURCE_UNSPECIFIED - - APM_SOURCE_E2M - - APM_SOURCE_SPAN_METRICS - type: string ApplicationNameConstraint: type: object properties: @@ -22145,27 +21463,6 @@ components: which individual arcs are displayed externalDocs: url: '' - ArchiveConfigurationGroupRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration group UUID v7. - description: Request to archive a fleet-manager configuration group. - externalDocs: - url: '' - ArchiveConfigurationGroupResponse: - type: object - additionalProperties: false - description: >- - Empty response returned after archiving a fleet-manager configuration - group. - externalDocs: - url: '' ArchiveRetention: type: object properties: @@ -22204,76 +21501,6 @@ components: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - ArchiveTarget: - type: object - oneOf: - - required: - - s3 - type: object - - required: - - ibmCos - type: object - - type: object - not: - anyOf: - - required: - - s3 - type: object - - required: - - ibmCos - type: object - properties: - enableTags: - type: boolean - filenamePrefix: - minLength: 0 - type: string - format: - $ref: '#/components/schemas/Format' - ibmCos: - $ref: '#/components/schemas/IBMCosTargetSpec' - maxCompactionLevel: - type: integer - format: int32 - partitioningScheme: - $ref: '#/components/schemas/PartitioningScheme' - prefix: - minLength: 0 - type: string - providerType: - $ref: '#/components/schemas/ProviderType' - s3: - $ref: '#/components/schemas/S3TargetSpec' - tags: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ObjectTag' - AssignCaseRequest: - title: Assign case request - required: - - id - - assignee - type: object - properties: - assignee: - allOf: - - $ref: '#/components/schemas/cases.v1.UserDetails' - description: User to assign the case to - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to assign. Accepts either the case UUID (the `id` - field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - description: Request to assign a case to a specific user. - externalDocs: - url: '' AssignCaseResponse: title: Assign case response required: @@ -22287,41 +21514,6 @@ components: description: Response containing the case after a user assignment. externalDocs: url: '' - AssignDashboardFolderRequest: - title: Assign dashboard to folder request data structure - required: - - requestId - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - folderId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: >- - The ID of the folder to assign the dashboard to. Set to null to - assign to the root folder. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the assign folder request, used to prevent - duplicate operations. - description: This is a request for assigning a folder to a dashboard - externalDocs: - description: Find out more about Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ AssignDashboardFolderResponse: title: Assign dashboard to folder response data structure type: object @@ -22333,35 +21525,6 @@ components: description: Find out more about Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - AssignIncidentsRequest: - title: Assign incidents request - required: - - incidentIds - - assignedTo - type: object - properties: - assignedTo: - allOf: - - $ref: '#/components/schemas/incidents.v1.UserDetails' - description: User to assign the incidents to - incidentIds: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of incident IDs to assign - description: List of incident IDs to assign - example: - - 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - - 9c858901-8a57-4791-81fe-4c455b099bc9 - description: Request to assign one or more incidents to a user - externalDocs: - url: '' AssignIncidentsResponse: title: Assign incidents response required: @@ -22516,59 +21679,6 @@ components: was assigned externalDocs: url: '' - AtomicBatchCreatePolicyRequest: - title: Atomic Batch Create Policy Request - required: - - policyRequests - type: object - properties: - policyRequests: - maxItems: 200 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/CreatePolicyRequest' - description: The policy creation requests. Must not be empty. - description: This data structure is used to create multiple policies atomically. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - AtomicBatchCreatePolicyResponse: - title: Atomic Batch Create Policy Response - required: - - createResponses - type: object - properties: - createResponses: - maxItems: 200 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreatePolicyResponse' - description: The create responses. - description: >- - This data structure is obtained when creating multiple policies - atomically. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - AtomicBatchExecuteActionsRequest: - type: object - properties: - requests: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ActionExecutionRequest' - description: The requests. - description: >- - This data structure represents a request to execute a batch of Action - operations atomically. - externalDocs: - url: '' AtomicBatchExecuteActionsResponse: type: object properties: @@ -22584,21 +21694,6 @@ components: request. externalDocs: url: '' - AtomicBatchExecuteE2MRequest: - type: object - properties: - requests: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/E2MExecutionRequest' - description: The requests. - description: >- - Request containing an atomic list of events-to-metrics actions to - execute. - externalDocs: - url: '' AtomicBatchExecuteE2MResponse: type: object properties: @@ -22614,22 +21709,6 @@ components: events-to-metrics rules. externalDocs: url: '' - AtomicOverwriteAllEnrichmentsRequest: - type: object - properties: - requestEnrichments: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EnrichmentRequestModel' - description: >- - Complete list of enrichment rules to replace all existing rules. The - total number of enrichment rules is limited by the account's - enrichment limit (5 by default). - description: Request to atomically replace all enrichment rules. - externalDocs: - url: '' AtomicOverwriteAllEnrichmentsResponse: type: object properties: @@ -22643,34 +21722,6 @@ components: description: Response returned after atomically replacing all enrichment rules. externalDocs: url: '' - AtomicOverwriteEnrichmentsRequest: - type: object - properties: - enrichmentFields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EnrichmentFieldDefinition' - description: 'Deprecated: enrichment field definitions.' - deprecated: true - enrichmentType: - allOf: - - $ref: '#/components/schemas/EnrichmentType' - deprecated: true - requestEnrichments: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EnrichmentRequestModel' - description: >- - List of enrichment rules to atomically replace existing rules. The - total number of enrichment rules is limited by the account's - enrichment limit (5 by default). - description: Request to atomically update enrichment rules. - externalDocs: - url: '' AtomicOverwriteEnrichmentsResponse: type: object properties: @@ -22684,26 +21735,6 @@ components: description: Response returned after atomically updating enrichment rules. externalDocs: url: '' - AtomicOverwriteLogPoliciesRequest: - title: Atomic Overwrite Log Policies Request - required: - - policies - type: object - properties: - policies: - maxItems: 200 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateLogPolicyRequest' - description: Policies. - description: >- - In an atomic operation delete all existing log policies and create the - provided list by order. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ AtomicOverwriteLogPoliciesResponse: title: Atomic Overwrite Log Policies Response type: object @@ -22720,26 +21751,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - AtomicOverwriteRumPoliciesRequest: - title: Atomic Overwrite Rum Policies Request - required: - - policies - type: object - properties: - policies: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateRumPolicyRequest' - description: List of RUM policies to create as part of the atomic overwrite. - description: >- - In an atomic operation delete all existing RUM policies and create the - provided list by order. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ AtomicOverwriteRumPoliciesResponse: title: Atomic Overwrite Rum Policies Response type: object @@ -22758,26 +21769,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - AtomicOverwriteSpanPoliciesRequest: - title: Atomic Overwrite Span Policies Request - required: - - policies - type: object - properties: - policies: - maxItems: 200 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateSpanPolicyRequest' - description: List of span policies to create as part of the atomic overwrite. - description: >- - In an atomic operation delete all existing span policies and create the - provided list by order. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ AtomicOverwriteSpanPoliciesResponse: title: Atomic Overwrite Span Policies Response type: object @@ -22834,22 +21825,6 @@ components: - LOGS type: string description: Attachment type. - Attachments: - title: Alert notification attachments - type: object - properties: - logExample: - minLength: 0 - type: string - externalDocs: - url: '' - AuditLogDescription: - type: object - properties: - description: - minLength: 0 - type: string - description: Human-readable description. AutoCloseConfig: title: Auto Close config required: @@ -23390,21 +22365,6 @@ components: description: Bar chart.stack definition. externalDocs: url: '' - BatchExecuteSloRequest: - title: BatchExecuteSloRequest - required: - - requests - type: object - properties: - requests: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SloExecutionRequest' - description: The requests. - description: Request to batch execute multiple SLO operations. - externalDocs: - url: '' BatchExecuteSloResponse: title: BatchExecuteSloResponse required: @@ -23422,75 +22382,6 @@ components: description: Response containing the results of batch executed SLO operations. externalDocs: url: '' - BatchGetAlertDefRequest: - title: Batch get alert definitions request - type: object - properties: - ids: - maxItems: 1000 - minItems: 0 - type: array - items: - maxLength: 36 - minLength: 1 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - example: - - 123e4567-e89b-12d3-a456-426614174000 - description: A request to retrieve multiple alert definitions by their IDs - externalDocs: - url: '' - BatchGetAlertDefResponse: - title: Batch get alert definitions response - type: object - properties: - alertDefs: - type: object - additionalProperties: - $ref: '#/components/schemas/AlertDef' - description: Map of alert definition IDs to alert definitions - notFoundIds: - maxItems: 1000 - minItems: 0 - type: array - items: - maxLength: 36 - minLength: 1 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The not found ids. - description: The not found ids. - example: - - 123e4567-e89b-12d3-a456-426614174000 - description: >- - A response that contains the requested alert definitions and not-found - alert IDs - externalDocs: - url: '' - BatchGetConnectorSummariesRequest: - title: Batch Get Connector Summaries Request - type: object - properties: - connectorIds: - maxItems: 800 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: >- - The unique identifiers of the connectors whose summaries to - retrieve. - description: >- - The unique identifiers of the connectors whose summaries to - retrieve. - description: Request to retrieve multiple connector summaries by their IDs - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ BatchGetConnectorSummariesResponse: title: Batch Get Connector Summaries Response type: object @@ -23518,27 +22409,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - BatchGetConnectorsRequest: - title: Batch Get Connectors Request - type: object - properties: - connectorIds: - maxItems: 800 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The unique identifiers of the connectors to retrieve. - description: The unique identifiers of the connectors to retrieve. - example: - - connector-id-1 - - connector-id-2 - description: Request to retrieve multiple connectors by their IDs - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ BatchGetConnectorsResponse: title: Batch Get Connectors Response type: object @@ -23564,36 +22434,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - BatchGetEventRequest: - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/EventsQueryFilter' - description: Optional filter to narrow the set of returned events. - ids: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The ids. - description: The ids. - orderBys: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/events.v3.OrderBy' - description: Ordering criteria for the returned events. - pagination: - allOf: - - $ref: '#/components/schemas/events.v3.PaginationRequest' - description: Pagination parameters for the response. - description: >- - Request to retrieve multiple alert events by IDs with optional filtering - and pagination. - externalDocs: - url: '' BatchGetEventResponse: type: object properties: @@ -23615,28 +22455,6 @@ components: description: Response containing the details of an alert event. externalDocs: url: '' - BatchGetGlobalRoutersRequest: - title: Batch Get Global Routers Request - type: object - properties: - globalRouterIds: - maxItems: 200 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: >- - The unique identifiers of the global routers to retrieve summaries - for. - description: >- - The unique identifiers of the global routers to retrieve summaries - for. - description: Get global routers by provided identifiers - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ BatchGetGlobalRoutersResponse: title: Batch Get Global Routers Response type: object @@ -23664,25 +22482,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - BatchGetIncidentRequest: - title: Batch get incidents request - type: object - properties: - ids: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The ids. - description: The ids. - description: Request to get multiple incidents by their IDs - externalDocs: - url: '' BatchGetIncidentResponse: title: Batch get incidents response required: @@ -23715,24 +22514,6 @@ components: found externalDocs: url: '' - BatchGetPresetsRequest: - title: Batch Get Presets Request - type: object - properties: - presetIds: - maxItems: 600 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The unique identifiers of the presets to retrieve. - description: The unique identifiers of the presets to retrieve. - description: Request to get multiple presets by their ids - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ BatchGetPresetsResponse: title: Batch Get Presets Response type: object @@ -23756,23 +22537,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - BatchGetSlosRequest: - title: BatchGetSlosRequest - required: - - ids - type: object - properties: - ids: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The ids. - description: The ids. - description: Request to retrieve multiple SLOs by their IDs. - externalDocs: - url: '' BatchGetSlosResponse: title: BatchGetSlosResponse required: @@ -23809,19 +22573,6 @@ components: description: Block parameters. externalDocs: url: '' - BlockRequest: - type: object - properties: - ruleExpressions: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RuleExpression' - BooleanOperator: - enum: - - BOOLEAN_OPERATOR_AND_UNSPECIFIED - - BOOLEAN_OPERATOR_OR - type: string BreachStatus: title: Breach status enum: @@ -23903,61 +22654,6 @@ components: description: A single time bucket of grouped usage entries. externalDocs: url: '' - BucketChunk: - type: object - properties: - bucketIndex: - minimum: 0 - type: integer - format: int64 - bucketRange: - $ref: '#/components/schemas/UsageTimestampRange' - chunkIndex: - minimum: 0 - type: integer - format: int64 - entries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UsageEntry' - lastChunkForBucket: - type: boolean - BulkAcknowledgeRequest: - title: Bulk acknowledge request - required: - - ids - - actor - type: object - properties: - actor: - allOf: - - $ref: '#/components/schemas/cases.v1.UserDetails' - description: User performing the acknowledgment - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to acknowledge. Each entry accepts either the - case UUID (the `id` field on a case) or the readable identifier - (the `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to acknowledge. Each entry accepts either the case - UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - description: Request to acknowledge multiple cases - externalDocs: - url: '' BulkAcknowledgeResponse: title: Bulk acknowledge response required: @@ -23974,41 +22670,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkAssignRequest: - title: Bulk assign request - required: - - ids - - assignee - type: object - properties: - assignee: - allOf: - - $ref: '#/components/schemas/cases.v1.UserDetails' - description: User to assign the cases to - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to assign. Each entry accepts either the case - UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to assign. Each entry accepts either the case UUID - (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - description: Request to assign multiple cases to a user - externalDocs: - url: '' BulkAssignResponse: title: Bulk assign response required: @@ -24025,34 +22686,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkClearPriorityOverrideRequest: - title: Bulk clear priority override request - type: object - properties: - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to clear priority override for. Each entry - accepts either the case UUID (the `id` field on a case) or the - readable identifier (the `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to clear priority override for. Each entry accepts - either the case UUID (the `id` field on a case) or the readable - identifier (the `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - description: Request to clear priority override for multiple cases - externalDocs: - url: '' BulkClearPriorityOverrideResponse: title: Bulk clear priority override response required: @@ -24069,36 +22702,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkCloseRequest: - title: Bulk close request - required: - - ids - type: object - properties: - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to close. Each entry accepts either the case UUID - (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to close. Each entry accepts either the case UUID - (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - description: Request to close multiple cases - externalDocs: - url: '' BulkCloseResponse: title: Bulk close response required: @@ -24115,24 +22718,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkCreateAlertDefsRequest: - title: Bulk create alert definitions request - required: - - alertDefsToCreate - type: object - properties: - alertDefsToCreate: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/AlertDefToCreate' - description: >- - List of alert definitions to create. Limited to 100 alert - definitions per request. - description: A request to create multiple alert definitions - externalDocs: - url: '' BulkCreateAlertDefsResponse: title: Bulk create alert definitions response type: object @@ -24160,27 +22745,6 @@ components: description: A response that contains the results of the bulk create operation externalDocs: url: '' - BulkDeleteAlertDefsRequest: - title: Bulk delete alert definitions request - type: object - properties: - ids: - maxItems: 100 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 1 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of alert definition IDs to delete. - description: List of alert definition IDs to delete. - example: - - 123e4567-e89b-12d3-a456-426614174000 - description: A request to delete multiple alert defintions by their IDs - externalDocs: - url: '' BulkDeleteAlertDefsResponse: title: Bulk delete alert definitions response type: object @@ -24218,39 +22782,12 @@ components: atomic - either all alerts are deleted or none are. externalDocs: url: '' - BulkDeleteRuleGroupRequest: - type: object - properties: - groupIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The unique identifiers of the parsing rule groups to delete. - description: The unique identifiers of the parsing rule groups to delete. BulkDeleteRuleGroupResponse: type: object additionalProperties: false description: Response returned after deleting all parsing rule groups. externalDocs: url: '' - BulkReplaceAlertDefsRequest: - title: Bulk replace alert definitions request - type: object - properties: - alertDefsToReplace: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AlertDefToReplace' - description: >- - List of alert definitions to replace. Limited to 100 alert - definitions per request. - description: A request to bulk replace multiple alert definitions - externalDocs: - url: '' BulkReplaceAlertDefsResponse: title: Bulk replace alert definitions response type: object @@ -24302,43 +22839,6 @@ components: description: A response that contains the results of the bulk replace operation externalDocs: url: '' - BulkResolveRequest: - title: Bulk resolve request - required: - - ids - type: object - properties: - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to resolve. Each entry accepts either the case - UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to resolve. Each entry accepts either the case UUID - (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - reason: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Reason for resolution - example: These cases are no longer active. - description: Request to resolve multiple cases - externalDocs: - url: '' BulkResolveResponse: title: Bulk resolve response required: @@ -24355,42 +22855,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkSetPriorityOverrideRequest: - title: Bulk override priority request - required: - - ids - - priority - type: object - properties: - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to override priority for. Each entry accepts - either the case UUID (the `id` field on a case) or the readable - identifier (the `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to override priority for. Each entry accepts either - the case UUID (the `id` field on a case) or the readable identifier - (the `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - priority: - allOf: - - $ref: '#/components/schemas/CasePriority' - description: Priority value to override with - example: CASE_PRIORITY_P3 - description: Request to override priority for multiple cases - externalDocs: - url: '' BulkSetPriorityOverrideResponse: title: Bulk override priority response required: @@ -24407,24 +22871,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BulkTestLogPoliciesRequest: - title: Bulk Test Log Policies Request - required: - - metaFieldsValuesList - type: object - properties: - metaFieldsValuesList: - maxItems: 50 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LogMetaFieldsValues' - description: The meta fields values list. - description: Request to test multiple log policies. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ BulkTestLogPoliciesResponse: title: Bulk Test Log Policies Response required: @@ -24443,34 +22889,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - BulkUnassignRequest: - title: Bulk unassign request - type: object - properties: - ids: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - IDs of the cases to unassign. Each entry accepts either the case - UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - description: >- - IDs of the cases to unassign. Each entry accepts either the case - UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - CASE-123 - description: Request to unassign multiple cases - externalDocs: - url: '' BulkUnassignResponse: title: Bulk unassign response required: @@ -24487,68 +22905,6 @@ components: description: Response containing the updated cases externalDocs: url: '' - BurnRateAlertDefinition: - type: object - oneOf: - - required: - - dual - type: object - - required: - - single - type: object - - type: object - not: - anyOf: - - required: - - dual - type: object - - required: - - single - type: object - properties: - dual: - $ref: '#/components/schemas/BurnRateAlertTypeDual' - single: - $ref: '#/components/schemas/BurnRateAlertTypeSingle' - BurnRateAlertTypeDual: - type: object - properties: - longWindow: - minLength: 0 - type: string - shortWindow: - minLength: 0 - type: string - thresholds: - minItems: 0 - type: array - items: - type: number - format: double - BurnRateAlertTypeSingle: - type: object - properties: - thresholds: - minItems: 0 - type: array - items: - type: number - format: double - window: - minLength: 0 - type: string - BurnRateMetricTypeDual: - type: object - properties: - longMetricFilter: - $ref: '#/components/schemas/SloMetricFilter' - shortMetricFilter: - $ref: '#/components/schemas/SloMetricFilter' - BurnRateMetricTypeSingle: - type: object - properties: - metricFilter: - $ref: '#/components/schemas/SloMetricFilter' BurnRateThreshold: title: Burn Rate Threshold type: object @@ -24605,18 +22961,6 @@ components: description: Burn rate type single definition externalDocs: url: '' - ByApmServiceName: - type: object - properties: - serviceName: - minLength: 0 - type: string - ByMetricName: - type: object - properties: - name: - minLength: 0 - type: string Case: title: Case required: @@ -25260,31 +23604,6 @@ components: - CASE_ORDER_BY_FIELD_CREATED_AT type: string description: Field used for ordering cases (e.g., priority, status, category). - CasePatch: - title: Case patch - type: object - properties: - resolutionReason: - maxLength: 500 - minLength: 1 - pattern: ^[\s\S]*\S[\s\S]*$ - type: string - description: >- - New case resolution reason. Leading and trailing whitespace is - trimmed before the length limits are applied. - example: False alarm - title: - maxLength: 512 - minLength: 1 - pattern: ^[\s\S]*\S[\s\S]*$ - type: string - description: >- - New case title. Leading and trailing whitespace is trimmed before - the length limits are applied. - example: Database connection investigation - description: Partial set of fields to update on the case - externalDocs: - url: '' CasePriority: enum: - CASE_PRIORITY_UNSPECIFIED @@ -25295,40 +23614,6 @@ components: - CASE_PRIORITY_P5 type: string description: Case priority. - CasePriorityFilter: - type: object - oneOf: - - required: - - all - type: object - - required: - - values - type: object - - type: object - not: - anyOf: - - required: - - all - type: object - - required: - - values - type: object - properties: - all: - $ref: '#/components/schemas/CasePriorityFilterAll' - values: - $ref: '#/components/schemas/CasePriorityFilterValues' - CasePriorityFilterAll: - type: object - additionalProperties: false - CasePriorityFilterValues: - type: object - properties: - items: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CasePriority' CaseResolver: title: Case resolver type: object @@ -25512,59 +23797,6 @@ components: description: Version. externalDocs: url: '' - ChartName: - title: Fleet-manager chart name - enum: - - CHART_NAME_UNSPECIFIED - - CHART_NAME_OTEL_INTEGRATION - - CHART_NAME_OPENTELEMETRY_COLLECTOR - - CHART_NAME_OTEL_LINUX_STANDALONE - - CHART_NAME_OTEL_WINDOWS_STANDALONE - - CHART_NAME_OTEL_MACOS_STANDALONE - - CHART_NAME_OTEL_ECS_EC2 - type: string - description: Helm chart name for fleet-manager configuration families. - CheckDashboardRequest: - title: Check dashboard request data structure - type: object - oneOf: - - required: - - dashboard - type: object - - required: - - dashboardId - type: object - - type: object - not: - anyOf: - - required: - - dashboard - type: object - - required: - - dashboardId - type: object - properties: - dashboard: - allOf: - - $ref: '#/components/schemas/Dashboard' - description: Dashboard definition to validate - dashboardId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Id of an existing dashboard to load and validate - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Optional idempotency key for the check request - description: Validate a dashboard definition or an existing dashboard by id - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ CheckDashboardResponse: title: Check dashboard response data structure type: object @@ -25581,25 +23813,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - ClearPriorityOverrideRequest: - title: Clear priority override request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case. Accepts either the case UUID (the `id` field on a - case) or the readable identifier (the `readable_id` field, e.g. - `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' ClearPriorityOverrideResponse: title: Clear priority override response required: @@ -25631,25 +23844,6 @@ components: description: Clear scope. externalDocs: url: '' - CloseCaseRequest: - title: Close case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to close. Accepts either the case UUID (the `id` - field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' CloseCaseResponse: title: Close case response required: @@ -25663,30 +23857,6 @@ components: description: Response containing the case after it has been closed. externalDocs: url: '' - CloseIncidentsRequest: - title: Close incidents request - required: - - incidentIds - type: object - properties: - incidentIds: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of incident IDs to close - description: List of incident IDs to close - example: - - 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - - 9c858901-8a57-4791-81fe-4c455b099bc9 - description: Request to close one or more incidents - externalDocs: - url: '' CloseIncidentsResponse: title: Close incidents response required: @@ -25784,51 +23954,6 @@ components: - UNAVAILABLE - DATA_LOSS type: string - CodeAgentIntegration: - type: object - properties: - integrationTypes: - maxItems: 25 - minItems: 1 - uniqueItems: true - type: array - items: - $ref: '#/components/schemas/CodeAgentIntegrationType' - description: >- - The integration types this product is marked for, ordered by name; a - team may have only some of them. Never empty and never contains - CODE_AGENT_INTEGRATION_TYPE_UNSPECIFIED. - product: - allOf: - - $ref: '#/components/schemas/AiCenterProduct' - description: The AI product this entry describes. - description: >- - A single AI product that is marked as successfully integrated for the - team, together with the integration types it is integrated through. - externalDocs: - url: '' - CodeAgentIntegrationType: - enum: - - CODE_AGENT_INTEGRATION_TYPE_UNSPECIFIED - - NATIVE_OTLP - - CORALOGIX_HOOK - - VENDOR_ADMIN_API - - VENDOR_ANALYTICS_API - - VENDOR_GITHUB_APP - - VENDOR_COMPLIANCE_API - - VENDOR_ORG_API - - VENDOR_AGENT_API - - CORALOGIX_TRANSCRIPT_COLLECTOR - - VENDOR_TEAM_API - type: string - description: >- - How an AI product's usage data reaches Coralogix. Values are generic and - read together with the product: VENDOR_ANALYTICS_API is the Anthropic - Analytics key under CLAUDE_CODE and the OpenAI Codex Analytics key under - CODEX. Any accepted product may be paired with any integration type; - which combinations carry data depends on the integrations that exist at - the time, not on this contract. New values are added over time; clients - must tolerate values they do not recognize. ColorApplyTarget: enum: - COLOR_APPLY_TARGET_UNSPECIFIED @@ -26133,49 +24258,6 @@ components: description: Event recorded when a user posts a comment on a case. externalDocs: url: '' - CommonARMParams: - title: Common ARM integration parameters - type: object - properties: - apiKey: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: API key used to authenticate requests for template access. - cgxDomain: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The cgx domain. - logsUrl: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The logs url. - externalDocs: - url: '' - CompanyArchiveConfig: - title: Common Archive Config - type: object - properties: - archiveConfigured: - type: boolean - example: true - companyId: - minimum: 0 - type: integer - format: int64 - example: 1234567 - description: >- - This data structure represents a common archive configuration for a - company within the organization. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ CompanyEnrichmentSettings: type: object properties: @@ -26283,14 +24365,6 @@ components: description: Company-wide custom model pricing configuration. externalDocs: url: '' - CompanyModelPricing.PricesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ModelPrice' ComparisonOperator: enum: - COMPARISON_OPERATOR_UNSPECIFIED @@ -26354,396 +24428,6 @@ components: description: The value. externalDocs: url: '' - ConfigurationFamily: - type: object - properties: - active: - type: boolean - description: Whether this family is active. - basedOnConfigurationFamilyId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration family UUID v7 this family is based on. - chartName: - allOf: - - $ref: '#/components/schemas/ChartName' - description: Helm chart name for Helm-backed families. - chartVersion: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Helm chart or template version used by this family. - collectorVersion: - maxLength: 256 - minLength: 5 - pattern: >- - ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$ - type: string - description: >- - Collector semantic version this configuration family targets, - without a leading v prefix. - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration family UUID v7. - integrationVersion: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Integration version from the onboarding flow. - lastActivatedAt: - maxLength: 64 - minLength: 0 - type: string - description: Time when this family was last activated. - format: date-time - metadata: - type: object - additionalProperties: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Metadata stored with this configuration family. - remoteConfigurations: - maxItems: 128 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RemoteConfiguration' - description: Remote configurations in this family. - version: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Monotonic version number of this configuration family within its - group. - description: Configuration family returned by Fleet Manager. - externalDocs: - url: '' - ConfigurationFamily.MetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - ConfigurationFamilyCreate: - type: object - properties: - active: - type: boolean - description: Whether this family is active. - basedOnConfigurationFamilyId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration family UUID v7 this family is based on. - collectorVersion: - maxLength: 256 - minLength: 5 - pattern: >- - ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$ - type: string - description: >- - Collector semantic version this configuration family targets, - without a leading v prefix. The service.version selector must match - this value or is added automatically. - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - metadata: - type: object - additionalProperties: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Metadata stored with this configuration family. - remoteConfigurations: - maxItems: 128 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationCreate' - description: Remote configurations to create in this family. - description: Initial configuration family to create. - externalDocs: - url: '' - ConfigurationFamilyCreate.MetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - ConfigurationFamilyReplace: - type: object - properties: - active: - type: boolean - description: Whether this family is active. - collectorVersion: - maxLength: 256 - minLength: 5 - pattern: >- - ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$ - type: string - description: >- - Collector semantic version this configuration family targets, - without a leading v prefix. The service.version selector must match - this value or is added automatically. - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - metadata: - type: object - additionalProperties: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Metadata stored with this configuration family. - remoteConfigurations: - maxItems: 128 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationReplace' - description: >- - Remote configurations to use when creating or replacing family - content. - description: >- - Fields used to update the latest configuration family. Omitted optional - fields keep their existing values. - externalDocs: - url: '' - ConfigurationFamilyReplace.MetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - ConfigurationGroup: - type: object - properties: - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - families: - maxItems: 128 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ConfigurationFamily' - description: Configuration families in this group. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration group UUID v7. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Display name. - priorityOrder: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: >- - Selection precedence. Higher values win on ties and 0 is the - default. - format: int32 - tags: - maxItems: 64 - minItems: 0 - type: array - items: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Tags attached to the configuration group. - description: Tags attached to the configuration group. - description: Fleet-manager configuration group. - externalDocs: - url: '' - ConfigurationGroupCreate: - type: object - properties: - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - family: - allOf: - - $ref: '#/components/schemas/ConfigurationFamilyCreate' - description: Initial configuration family to create with this group. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Display name. - priorityOrder: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: >- - Selection precedence. Higher values win on ties and 0 is the - default. - format: int32 - tags: - maxItems: 64 - minItems: 0 - type: array - items: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Tags attached to the configuration group. - description: Tags attached to the configuration group. - description: Payload used to create a fleet-manager configuration group. - externalDocs: - url: '' - ConfigurationGroupReplace: - type: object - properties: - description: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - family: - allOf: - - $ref: '#/components/schemas/ConfigurationFamilyReplace' - description: >- - Fields used to update the latest configuration family. Versioned - content changes create a new family version. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration group UUID v7. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Display name. - priorityOrder: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: >- - Selection precedence. Higher values win on ties and 0 is the - default. - format: int32 - tags: - maxItems: 64 - minItems: 0 - type: array - items: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Tags attached to the configuration group. - description: Tags attached to the configuration group. - description: >- - Fields used to update a fleet-manager configuration group. Omitted - optional fields keep their existing values. - externalDocs: - url: '' - ConfigureTenantRequest: - title: Configure Tenant Request - type: object - oneOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - - type: object - not: - anyOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - properties: - gcs: - allOf: - - $ref: '#/components/schemas/GcsConfig' - description: Google Cloud Storage configuration. - ibm: - allOf: - - $ref: '#/components/schemas/IbmConfigV2' - description: IBM Cloud Object Storage configuration. - retentionPolicy: - $ref: '#/components/schemas/RetentionPolicyRequest' - s3: - allOf: - - $ref: '#/components/schemas/S3Config' - description: AWS S3 storage configuration. - description: This data structure is used to configure a tenant. - externalDocs: - description: Find out more about metrics cost optimization - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ ConnectionStatus: enum: - PENDING @@ -26917,49 +24601,6 @@ components: description: Details of a notification connector. externalDocs: url: '' - ConnectorInternal: - type: object - properties: - configOverrides: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EntityTypeConfigOverrides' - description: The config overrides. - connectorConfig: - $ref: '#/components/schemas/ConnectorConfig' - createTime: - minLength: 0 - type: string - description: The create time. - format: date-time - description: - minLength: 0 - type: string - diagnostics: - allOf: - - $ref: '#/components/schemas/Diagnostics' - deprecated: true - id: - minLength: 0 - type: string - internalId: - minLength: 0 - type: string - name: - minLength: 0 - type: string - teamId: - minimum: 0 - type: integer - format: int64 - type: - $ref: '#/components/schemas/notification_center.ConnectorType' - updateTime: - minLength: 0 - type: string - description: Timestamp of the last update. - format: date-time ConnectorSchema: type: object properties: @@ -26986,14 +24627,6 @@ components: description: Connector schema. externalDocs: url: '' - ConnectorSummariesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ConnectorSummary' ConnectorSummary: title: Connector Summary type: object @@ -27102,14 +24735,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ConnectorsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/Connector' Constant: type: object properties: @@ -27235,21 +24860,6 @@ components: - CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED type: string description: Coralogix customer support access. - CoralogixLogMetadata: - type: object - properties: - applicationName: - minLength: 0 - type: string - description: The application name. - severity: - minLength: 0 - type: string - description: Severity. - subsystemName: - minLength: 0 - type: string - description: The subsystem name. CoralogixUser: title: Coralogix user resolver type: object @@ -27263,12 +24873,6 @@ components: description: Count. externalDocs: url: '' - CountAiAppsPerEvalTypeRequest: - type: object - additionalProperties: false - description: Request to count AI applications per evaluation type. - externalDocs: - url: '' CountAiAppsPerEvalTypeResponse: type: object properties: @@ -27314,16 +24918,6 @@ components: description: Counts. externalDocs: url: '' - CountsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minimum: 0 - type: integer - format: int64 CreateActionRequest: type: object properties: @@ -27398,41 +24992,6 @@ components: description: This data structure represents the response to create an Action. externalDocs: url: '' - CreateAiEvaluationRequest: - type: object - properties: - application: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Name of the AI application this evaluation belongs to. - config: - allOf: - - $ref: '#/components/schemas/EvaluationConfig' - description: Type-specific configuration (oneof). - isEnabled: - type: boolean - description: Whether the evaluation should start active. - subsystem: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Subsystem within the application. - target: - allOf: - - $ref: '#/components/schemas/EvaluationTarget' - description: 'What the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION.' - threshold: - maximum: 1 - minimum: 0 - type: number - description: Score threshold. Must be between 0.0 and 1.0 inclusive. - format: double - description: Request to create a new AI evaluation. - externalDocs: - url: '' CreateAiEvaluationResponse: type: object properties: @@ -27443,26 +25002,6 @@ components: description: Response returned after creating an AI evaluation. externalDocs: url: '' - CreateAlertDefRequest: - title: Create alert definition request - type: object - properties: - accessPolicy: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: >- - The access policy for the alert as a raw JSON string. Optional; - requires the alerts:UpdateAccessPolicy permission to set. If - omitted, the alert is created without an access policy. - alertDefProperties: - allOf: - - $ref: '#/components/schemas/AlertDefProperties' - description: The properties of the alert definition - description: A request to create a new alert definition - externalDocs: - url: '' CreateAlertDefResponse: title: Create alert definition response type: object @@ -27500,36 +25039,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - CreateApiKeyRequest: - title: Create Api Key Request - type: object - properties: - accessPolicy: - minLength: 0 - type: string - description: >- - JSON string representing the access policy for this API key. Defines - granular permissions for users and groups. - example: >- - {"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]} - hashed: - type: boolean - description: Whether the value is stored as a one-way hash. - example: true - keyPermissions: - $ref: '#/components/schemas/CreateApiKeyRequest.KeyPermissions' - name: - minLength: 0 - type: string - description: Display name. - example: my_api_key - owner: - $ref: '#/components/schemas/Owner' - description: This data structure is used to create an API key. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ CreateApiKeyRequest.KeyPermissions: title: Key Permissions type: object @@ -27583,38 +25092,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - CreateApmSloRequest: - type: object - properties: - apmSlo: - $ref: '#/components/schemas/ApmSloInput' - metricSource: - $ref: '#/components/schemas/ApmSource' - silenceDataValidations: - type: boolean - deprecated: true - CreateApmSloResponse: - type: object - properties: - slo: - $ref: '#/components/schemas/ApmSlo' - CreateBulkAlertSchedulerRuleRequest: - title: Create bulk alert scheduler rule request data structure - required: - - createAlertSchedulerRuleRequests - type: object - properties: - createAlertSchedulerRuleRequests: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateAlertSchedulerRuleRequest' - description: The create alert scheduler rule requests. - description: This is a request sent to create multiple alert scheduler rules - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ CreateBulkAlertSchedulerRuleResponse: title: Create bulk alert scheduler rule response data structure required: @@ -27632,30 +25109,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - CreateCaseSettingsRequest: - title: Create case settings request - required: - - globalIndicatorSettings - type: object - properties: - caseLifecycle: - allOf: - - $ref: '#/components/schemas/CaseLifecycle' - description: Case lifecycle settings for the team - globalIndicatorSettings: - allOf: - - $ref: '#/components/schemas/GlobalIndicatorSettings' - description: Configuration settings - name: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Optional display name for the case settings team configuration - example: Primary Case Settings - description: Request to create a new case settings team configuration. - externalDocs: - url: '' CreateCaseSettingsResponse: title: Create case settings response required: @@ -27669,43 +25122,6 @@ components: description: Response containing the newly created case settings team configuration. externalDocs: url: '' - CreateCommentRequest: - title: Create comment event request - required: - - caseId - - text - type: object - properties: - attachments: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CommentAttachment' - description: Attachments to the comment - caseId: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to add the event to. Accepts either the case UUID - (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - text: - maxLength: 10000 - minLength: 1 - pattern: ^[\s\S]*\S[\s\S]*$ - type: string - description: >- - Comment text to update. Leading and trailing whitespace is trimmed - before the length limits are applied. - example: This is updated text - description: Request for creating a comment on a case. - externalDocs: - url: '' CreateCommentResponse: title: Create comment event response required: @@ -27719,26 +25135,6 @@ components: description: Response returned after successfully creating a comment. externalDocs: url: '' - CreateCompanyIpAccessSettingsRequest: - title: Create company IP access settings request - type: object - properties: - enableCoralogixCustomerSupportAccess: - allOf: - - $ref: '#/components/schemas/CoralogixCustomerSupportAccess' - description: The Coralogix customer support access setting. - example: CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED - ipAccess: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/IpAccess' - description: List of IP access entries to create. - description: >- - This data structure represents the request to create company IP access - settings. - externalDocs: - url: '' CreateCompanyIpAccessSettingsResponse: title: Create company IP access settings response type: object @@ -27752,37 +25148,6 @@ components: settings. externalDocs: url: '' - CreateConfigurationGroupRequest: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/ConfigurationGroupCreate' - description: Configuration group to create. - description: Request to create a fleet-manager configuration group. - externalDocs: - url: '' - CreateConfigurationGroupResponse: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/ConfigurationGroup' - description: Created configuration group. - description: Response containing the created fleet-manager configuration group. - externalDocs: - url: '' - CreateConnectorRequest: - title: Create Connector Request - type: object - properties: - connector: - $ref: '#/components/schemas/Connector' - description: Request to create a new connector - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ CreateConnectorResponse: title: Create Connector Response type: object @@ -27794,37 +25159,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - CreateCustomEnrichmentRequest: - title: Create Custom Enrichment Request - required: - - name - - description - - file - type: object - properties: - description: - maxLength: 255 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description of the custom enrichment. - example: custom_enrichment_description - file: - $ref: '#/components/schemas/File' - name: - maxLength: 255 - minLength: 1 - pattern: ^\w+$ - type: string - description: >- - Human-readable name for the custom enrichment. May contain only - letters, digits, and underscores. - example: custom_enrichment_name - description: This request data structure is used to create a custom enrichment - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ CreateCustomEnrichmentResponse: title: Create Custom Enrichment Response type: object @@ -27845,70 +25179,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - CreateCustomEvaluationRequest: - type: object - properties: - applicationIds: - maxItems: 1024 - minItems: 0 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: IDs of AI applications to link this custom evaluation to. - description: IDs of AI applications to link this custom evaluation to. - description: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - examples: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CustomEvaluationExample' - description: Example conversations and expected scores. - instructions: - maxLength: 1048576 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Instructions sent to the LLM evaluator. - name: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Display name of the custom evaluation. - policyType: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Policy type identifier. - safe: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Description of what counts as safe. - shouldIncludeSystemPrompt: - type: boolean - description: Whether to include the system prompt in the LLM input. - violates: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Description of what counts as violating the policy. - description: Request to create a custom evaluation in the catalog. - externalDocs: - url: '' CreateCustomEvaluationResponse: type: object properties: @@ -27919,17 +25189,6 @@ components: description: Response returned after creating a custom evaluation. externalDocs: url: '' - CreateCustomPresetRequest: - title: Create Custom Preset Request - type: object - properties: - preset: - $ref: '#/components/schemas/Preset' - description: Request to create a new custom preset - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ CreateCustomPresetResponse: title: Create Custom Preset Response type: object @@ -27941,25 +25200,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - CreateDashboardFolderRequest: - title: Create dashboard folder request data structure - type: object - properties: - folder: - allOf: - - $ref: '#/components/schemas/DashboardFolder' - description: The folder. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The request id. - description: Request to create a new dashboard folder. - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ CreateDashboardFolderResponse: title: Create dashboard folder response data structure type: object @@ -27976,39 +25216,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - CreateDashboardRequest: - title: Create dashboard request data structure - required: - - requestId - - dashboard - type: object - properties: - accessPolicy: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: >- - JSON string representing the access policy for this dashboard. - Defines granular permissions for users and groups. - example: >- - {"version":"2025-01-01","default":{"permissions":{"team-dashboards:Read":"grant","team-dashboards:Update":"deny","team-dashboards:ReadAccessPolicy":"grant","team-dashboards:UpdateAccessPolicy":"deny"}},"rules":[]} - dashboard: - $ref: '#/components/schemas/Dashboard' - isLocked: - type: boolean - description: The is locked. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The request id. - description: This is a request used to create a new custom dashboard - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ CreateDashboardResponse: title: Create dashboard response data structure type: object @@ -28098,17 +25305,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - CreateGlobalRouterRequest: - title: Create Global Router Request - type: object - properties: - router: - $ref: '#/components/schemas/GlobalRouter' - description: Request to create a global router - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ CreateGlobalRouterResponse: title: Create Global Router Response type: object @@ -28120,14 +25316,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - CreateJobRequest: - type: object - properties: - jobDefinition: - $ref: '#/components/schemas/JobDefinition' - CreateJobResponse: - type: object - additionalProperties: false CreateLogPolicyRequest: title: Create Log Policy Request required: @@ -28144,57 +25332,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - CreateOllyAnalysisSettingsRequest: - type: object - properties: - enabled: - type: boolean - monthlyCapacity: - type: integer - format: int32 - ownershipLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FilterGroup' - priorityFilter: - $ref: '#/components/schemas/CasePriorityFilter' - CreateOllyAnalysisSettingsResponse: - type: object - properties: - ollyAnalysisSettings: - $ref: '#/components/schemas/OllyAnalysisSettings' - CreateOrReplaceGlobalRouterRequest: - title: Create Or Replace Global Router Request - type: object - properties: - router: - $ref: '#/components/schemas/GlobalRouter' - description: Creates or Updates already existing global router - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - CreateOrReplaceGlobalRouterResponse: - title: Create Or Replace Global Router Response - type: object - properties: - router: - $ref: '#/components/schemas/GlobalRouter' - description: Response which contains a created or updated router - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - CreateOutgoingWebhookRequest: - title: Create outgoing webhook request - type: object - properties: - data: - $ref: '#/components/schemas/OutgoingWebhookInputData' - description: Request for creating an outgoing webhook. - externalDocs: - url: '' CreateOutgoingWebhookResponse: title: Create outgoing webhook response type: object @@ -28207,94 +25344,6 @@ components: description: Response returned after successfully creating an outgoing webhook. externalDocs: url: '' - CreatePolicyRequest: - title: Create Policy Request - required: - - name - - priority - type: object - oneOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - - type: object - not: - anyOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - properties: - applicationRule: - $ref: '#/components/schemas/quota.v1.Rule' - archiveRetention: - $ref: '#/components/schemas/ArchiveRetention' - description: - maxLength: 255 - minLength: 0 - pattern: ^[\x00-\xFF]*$ - type: string - description: >- - Optional free-text description of the policy's purpose. Only Latin-1 - characters are accepted. - example: My Policy Description - disabled: - type: boolean - description: When true, the policy is disabled and will not be evaluated. - logRules: - $ref: '#/components/schemas/LogRules' - name: - maxLength: 255 - minLength: 1 - pattern: ^[\x00-\xFF]*$ - type: string - description: >- - Human-readable name for the policy. Only Latin-1 characters are - accepted. - example: My Policy - placement: - $ref: '#/components/schemas/Placement' - priority: - $ref: '#/components/schemas/quota.v1.Priority' - priorityOverride: - $ref: '#/components/schemas/PriorityOverride' - rumRules: - $ref: '#/components/schemas/LogRules' - spanRules: - $ref: '#/components/schemas/SpanRules' - subsystemRule: - $ref: '#/components/schemas/quota.v1.Rule' - targets: - maxItems: 5 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/v1.Target' - description: List of data targets/destinations to which this policy routes data. - example: - - name: My Target - dataset: dataset1 - priority: PRIORITY_TYPE_HIGH - archive_retention: - id: archive_retention_id - description: >- - This data structue is used to create a new policy. The number of - policies per source type is limited per account (200 by default). - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ CreatePolicyResponse: title: Create Policy Response required: @@ -28308,17 +25357,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - CreateQuotaAllocationRuleSetRequest: - title: Create quota allocation rule set request - required: - - ruleSet - type: object - properties: - ruleSet: - $ref: '#/components/schemas/QuotaAllocationEntityTypeRuleSet' - description: Request to create a new quota allocation rule set - externalDocs: - url: '' CreateQuotaAllocationRuleSetResponse: title: Create quota allocation rule set response type: object @@ -28330,91 +25368,6 @@ components: created externalDocs: url: '' - CreateRepositoriesRequest: - required: - - repositories - type: object - properties: - repositories: - maxItems: 1000 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/RepositorySetting' - description: >- - Repository settings to add. Each repository must be unique across - the list and must not already exist. - description: >- - Request to add one or more repository settings. Existing settings are - never modified or removed; adding a repository that already exists is - rejected. - externalDocs: - url: '' - CreateRepositoriesResponse: - type: object - properties: - repositories: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RepositorySetting' - description: The repository settings that were added. - description: Response containing the added repository settings. - externalDocs: - url: '' - CreateRoleRequest: - type: object - oneOf: - - required: - - parentRoleId - type: object - - required: - - parentRoleName - type: object - - type: object - not: - anyOf: - - required: - - parentRoleId - type: object - - required: - - parentRoleName - type: object - properties: - description: - minLength: 0 - type: string - description: Human-readable description. - name: - minLength: 0 - type: string - description: Display name. - parentRoleId: - minimum: 0 - type: integer - description: The parent role id. - format: int64 - parentRoleName: - minLength: 0 - type: string - description: The parent role name. - permissions: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of permissions. - description: List of permissions. - teamId: - minimum: 0 - type: integer - description: Team identifier. - format: int64 - description: Request for creating a custom role. - externalDocs: - url: '' CreateRoleResponse: type: object properties: @@ -28426,49 +25379,6 @@ components: description: Response returned after successfully creating a custom role. externalDocs: url: '' - CreateRuleGroupRequest: - type: object - properties: - creator: - minLength: 0 - type: string - description: Creator. - description: - minLength: 0 - type: string - description: Human-readable description. - enabled: - type: boolean - description: Whether this resource is enabled. - hidden: - type: boolean - description: The hidden. - name: - minLength: 0 - type: string - description: Display name. - order: - minimum: 0 - type: integer - description: Sort order. - format: int64 - ruleMatchers: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RuleMatcher' - description: The rule matchers. - ruleSubgroups: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup' - description: The rule subgroups. - teamId: - $ref: '#/components/schemas/v1.TeamId' - description: Request to create a new parsing rule group. - externalDocs: - url: '' CreateRuleGroupRequest.CreateRuleSubgroup: type: object properties: @@ -28520,28 +25430,6 @@ components: description: Response returned after successfully creating a parsing rule group. externalDocs: url: '' - CreateRuleGroupSet: - title: Create Rule Group Set - type: object - properties: - groups: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/InRuleGroup' - description: List of groups. - name: - maxLength: 255 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Display name. - description: A set of rule groups to create. - externalDocs: - description: Find out more about recording rules - url: >- - https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ CreateRuleGroupSetResult: title: Create Rule Group Set Result required: @@ -28575,39 +25463,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - CreateScopeRequest: - title: Create Scope Request - required: - - displayName - - filters - type: object - properties: - defaultExpression: - minLength: 0 - type: string - description: The default expression. - example: true - description: - minLength: 0 - type: string - description: Human-readable description. - example: The best scope - displayName: - minLength: 0 - type: string - description: The display name. - example: my-scope - filters: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/scopes.v1.Filter' - description: List of filters. - description: This data structure represents a request to create a scope - externalDocs: - description: Find out more about scopes - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ CreateScopeResponse: title: Create Scope Response required: @@ -28663,56 +25518,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - CreateTeamGroupRequest: - title: CreateTeamGroupRequest - type: object - properties: - description: - minLength: 0 - type: string - description: Human-readable description of the team group. - externalId: - minLength: 0 - type: string - description: >- - External identifier for the group, used when the group is managed by - an external identity provider. - groupType: - $ref: '#/components/schemas/GroupType' - name: - minLength: 0 - type: string - description: Unique display name for the new team group. - roleId: - minimum: 0 - type: integer - description: Identifier of the role to assign to this group. - format: int64 - scope: - $ref: '#/components/schemas/v2.Scope' - teamId: - minimum: 0 - type: integer - description: >- - Team to associate the group with. If not set, uses the authenticated - team. - format: int64 - userIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The user ids. - description: The user ids. - description: >- - Request to create a new team group with specified name, description, - roles, users, and optional scope filters. Can be associated with a - specific team or the authenticated team. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ CreateTeamGroupResponse: title: CreateTeamGroupResponse type: object @@ -28724,41 +25529,6 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - CreateTeamInOrgRequest: - required: - - teamName - type: object - properties: - dailyQuota: - type: number - description: >- - Daily quota to assign to the new team, in quota units per day. - Defaults to 0.01 when omitted. - format: double - teamAdminsEmail: - maxItems: 100 - minItems: 0 - type: array - items: - maxLength: 320 - minLength: 1 - pattern: ^[^@\s]+@[^@\s]+$ - type: string - description: >- - Email addresses of the users to add to the new team as - administrators. - description: >- - Email addresses of the users to add to the new team as - administrators. - teamName: - maxLength: 255 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Display name of the team to create. - description: Request to create a team in the calling user's organization. - externalDocs: - url: '' CreateTeamInOrgResponse: type: object properties: @@ -28769,60 +25539,6 @@ components: description: Response containing the identifier of the created team. externalDocs: url: '' - CreateUserRequest: - type: object - properties: - onboardingMode: - allOf: - - $ref: '#/components/schemas/OnboardingMode' - description: >- - Onboarding mode determines whether the user receives an invite link - or is created without one - userTemplate: - allOf: - - $ref: '#/components/schemas/UserTemplate' - description: Template containing all user properties to set during creation - CreateUserResult: - type: object - properties: - status: - $ref: '#/components/schemas/CreateUserStatus' - userAccountId: - minimum: 0 - type: integer - format: int64 - CreateUserStatus: - enum: - - CREATE_USER_STATUS_UNSPECIFIED - - CREATE_USER_STATUS_CREATED - - CREATE_USER_STATUS_ALREADY_EXISTS - - CREATE_USER_STATUS_INVITED - type: string - CreateUsersRequest: - title: CreateUsersRequest - type: object - properties: - teamId: - minimum: 0 - type: integer - description: Team ID where the users will be created - format: int64 - users: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CreateUserRequest' - description: >- - List of users to create. Multiple users can be created in a single - request. - description: >- - Request to create one or more new users within a team. Each user can be - configured with personal information, status, login modes, access type, - and onboarding method. - externalDocs: - description: Find out more about user management - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ CreateUsersResponse: title: CreateUsersResponse type: object @@ -28834,68 +25550,6 @@ components: description: Find out more about user management url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - CreateViewFolderRequest: - title: CreateViewFolderRequest - type: object - properties: - name: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Folder name - example: My Folder - description: Create view folder. - externalDocs: - url: '' - CreateViewFolderResponse: - title: CreateViewFolderRequest - type: object - properties: - folder: - $ref: '#/components/schemas/ViewFolder' - description: Request for creating view folder. - externalDocs: - url: '' - CreateViewRequest: - title: ViewFolder - required: - - name - - timeSelection - type: object - properties: - filters: - $ref: '#/components/schemas/SelectedFilters' - folderId: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: Unique identifier for folders - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - name: - maxLength: 250 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: View name - example: Logs view - searchQuery: - allOf: - - $ref: '#/components/schemas/SearchQuery' - description: The search query. - timeSelection: - $ref: '#/components/schemas/TimeSelection' - viewType: - $ref: '#/components/schemas/ViewType' - description: View folder. - externalDocs: - url: '' - CreateViewResponse: - type: object - properties: - view: - $ref: '#/components/schemas/View' CreatedCaseEvent: title: Created event type: object @@ -28908,11 +25562,6 @@ components: description: Created case event. externalDocs: url: '' - Csv: - type: object - properties: - version: - $ref: '#/components/schemas/csv.v1.Version' CustomAction: type: object properties: @@ -29331,15 +25980,6 @@ components: description: Find out more about events url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - CxEvent.CxEventLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string CxEventArray: title: CxEventArray required: @@ -29357,31 +25997,6 @@ components: description: Find out more about events url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - CxEventLabelsFieldStatisticsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/FieldStatistics' - CxEventMetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - CxEventMetadataFieldStatisticsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/FieldStatistics' CxEventSingleOrMultiple: title: CxEventSingleOrMultiple type: object @@ -29415,57 +26030,6 @@ components: description: Daily. externalDocs: url: '' - DailyTotals: - title: Daily Totals - required: - - cardinality - - bytesVolume - - unitUsage - type: object - oneOf: - - required: - - service - type: object - - required: - - metric - type: object - - type: object - not: - anyOf: - - required: - - service - type: object - - required: - - metric - type: object - properties: - bytesVolume: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Total bytes volume for the day. - cardinality: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Total cardinality for the day. - metric: - $ref: '#/components/schemas/MetricDailyExtra' - service: - $ref: '#/components/schemas/ServiceDailyExtra' - unitUsage: - type: number - description: Total billable unit usage for the day. - format: float - description: >- - Daily usage totals. Entity-specific extras (`service` or `metric`) are - populated when the resolved entity type has per-entity attributes; for - ENTITY_METRIC and ENTITY_SERVICE they are always present when totals are - returned. Future entity types may omit extras. - externalDocs: - url: '' Dashboard: title: Dashboard required: @@ -29779,49 +26343,6 @@ components: description: Dashboard folder. externalDocs: url: '' - DataPoint: - type: object - properties: - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - value: - type: number - format: double - DataSource: - type: object - properties: - exporter: - minLength: 0 - type: string - labelsMetric: - minLength: 0 - type: string - provider: - minLength: 0 - type: string - DataSourceType: - enum: - - DATA_SOURCE_TYPE_UNSPECIFIED - - DATA_SOURCE_TYPE_LOGS - - DATA_SOURCE_TYPE_SPAN - - DATA_SOURCE_TYPE_METRICS - - DATA_SOURCE_TYPE_EVENTS - - DATA_SOURCE_TYPE_PROFILES - type: string - DataSourceTypeValues: - type: object - properties: - dataSourceType: - $ref: '#/components/schemas/DataSourceType' - destinationExtractionKeys: - minItems: 0 - type: array - items: - minLength: 0 - type: string DataTable: type: object properties: @@ -30024,93 +26545,6 @@ components: description: A spans variant of the query externalDocs: url: '' - DataUsageEntry: - title: Data Usage Entry - type: object - properties: - dimensions: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Dimension' - description: The dimensions. - sizeGb: - type: number - description: The size gb. - format: float - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - units: - type: number - description: The units. - format: float - description: This data structure represents a data usage entry. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - DataUsageQuery: - type: object - oneOf: - - required: - - daily - type: object - - required: - - hourly - type: object - - type: object - not: - anyOf: - - required: - - daily - type: object - - required: - - hourly - type: object - properties: - daily: - $ref: '#/components/schemas/UsageDailyQuery' - filters: - maxItems: 16 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UsageLabelFilter' - description: Label predicates applied before aggregation. - groupBy: - allOf: - - $ref: '#/components/schemas/UsageGroupBy' - description: >- - Label keys to group results by. Supported keys are listed by the - capabilities endpoint. - hourly: - $ref: '#/components/schemas/UsageHourlyQuery' - limit: - allOf: - - $ref: '#/components/schemas/UsageLimit' - description: >- - Per-bucket result-size cap. The server may reject queries whose - pre-cap size still exceeds its hard limits. - measurementKindFilter: - maxItems: 8 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UsageMeasurementKind' - description: >- - Measurement kind filter applied before aggregation. Omit (or pass an - empty list) to include all supported measurement kinds. - description: Shared query payload used by both unary and streamed data-usage methods. - externalDocs: - url: '' - DataUsageRequest: - type: object - properties: - query: - $ref: '#/components/schemas/DataUsageQuery' DataUsageResponse: type: object properties: @@ -30173,33 +26607,6 @@ components: variable values. externalDocs: url: '' - DataprimeResult: - type: object - properties: - labels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataprimeResult.KeyValue' - description: Labels. - metadata: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataprimeResult.KeyValue' - userData: - minLength: 0 - type: string - DataprimeResult.KeyValue: - type: object - properties: - key: - minLength: 0 - type: string - description: Key. - value: - minLength: 0 - type: string DataprimeSource: type: object properties: @@ -30457,19 +26864,6 @@ components: description: This data structure represents the response to delete an Action. externalDocs: url: '' - DeleteAiApplicationRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI application to delete. - description: Request to delete an AI application. - externalDocs: - url: '' DeleteAiApplicationResponse: type: object properties: @@ -30483,19 +26877,6 @@ components: description: Response returned after deleting an AI application. externalDocs: url: '' - DeleteAiEvaluationRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI evaluation to delete. - description: Request to delete an AI evaluation. - externalDocs: - url: '' DeleteAiEvaluationResponse: type: object properties: @@ -30509,21 +26890,6 @@ components: description: Response returned after deleting an AI evaluation. externalDocs: url: '' - DeleteAlertDefRequest: - title: Delete alert definition request - type: object - properties: - id: - maxLength: 36 - minLength: 0 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The unique identifier of the alert definition to delete. - example: 123e4567-e89b-12d3-a456-426614174000 - description: A request to delete an alert definition by ID - externalDocs: - url: '' DeleteAlertDefResponse: title: Delete alert definition response type: object @@ -30531,64 +26897,18 @@ components: description: A response to the deletion of an alert definition externalDocs: url: '' - DeleteAlertSchedulerRuleRequest: - title: Update alert scheduler rule request data structure - type: object - properties: - alertSchedulerRuleId: - minLength: 0 - type: string - description: >- - The unique identifier of the alert scheduler (suppression) rule to - delete. - description: This is a request sent to update an alert scheduler rule - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ DeleteAlertSchedulerRuleResponse: type: object additionalProperties: false description: Response returned after successfully deleting an alert suppression rule. externalDocs: url: '' - DeleteApiKeyRequest: - title: Delete Api Key Request - type: object - properties: - keyId: - minLength: 0 - type: string - description: The unique identifier of the API key to delete. - description: This data structure is used to delete an API key. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ DeleteApiKeyResponse: type: object additionalProperties: false description: Response returned after successfully deleting an API key. externalDocs: url: '' - DeleteApiKeysRequest: - title: Delete API Keys Request - type: object - properties: - keyIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of API key IDs to delete. - example: key_abc123 - description: List of API key IDs to delete. - description: This data structure is used to delete specified API keys. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ DeleteApiKeysResponse: title: Delete API Keys Response type: object @@ -30598,37 +26918,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - DeleteBulkAlertSchedulerRuleRequest: - title: Delete bulk alert scheduler rule request data structure - required: - - deleteAlertSchedulerRuleRequests - type: object - properties: - deleteAlertSchedulerRuleRequests: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DeleteAlertSchedulerRuleRequest' - description: This is a request sent to delete multiple alert scheduler rules - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - DeleteCaseSettingsRequest: - title: Delete case settings request - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: ID of the case settings team configuration to delete - example: 8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321 - externalDocs: - url: '' DeleteCaseSettingsResponse: title: Delete case settings response type: object @@ -30636,22 +26925,6 @@ components: description: Empty response; success indicated by HTTP status externalDocs: url: '' - DeleteCommentRequest: - title: Delete comment request - required: - - eventId - type: object - properties: - eventId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: ID of the comment event to delete - example: f56645c5-9cd4-4b9f-961f-4f852d8835a0 - externalDocs: - url: '' DeleteCommentResponse: title: Delete comment response type: object @@ -30659,20 +26932,6 @@ components: description: Empty response; success indicated by HTTP status externalDocs: url: '' - DeleteCompanyIpAccessSettingsRequest: - title: Delete company IP access settings request - type: object - properties: - id: - minLength: 0 - type: string - description: The unique identifier of the company IP access settings to delete. - example: d662a2f1-21c3-493c-8f8a-595d3ab05ef3 - description: >- - This data structure represents the request to delete company IP access - settings. - externalDocs: - url: '' DeleteCompanyIpAccessSettingsResponse: title: Delete company IP access settings response type: object @@ -30682,12 +26941,6 @@ components: settings. externalDocs: url: '' - DeleteCompanyModelPricingRequest: - type: object - additionalProperties: false - description: Request to delete the company's custom model pricing. - externalDocs: - url: '' DeleteCompanyModelPricingResponse: type: object properties: @@ -30701,40 +26954,12 @@ components: description: Response returned after deleting company model pricing. externalDocs: url: '' - DeleteConnectorRequest: - title: Delete Connector Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: Unique identifier. - description: Request to delete a connector - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ DeleteConnectorResponse: type: object additionalProperties: false description: Response returned after successfully deleting a notification connector. externalDocs: url: '' - DeleteContextualDataIntegrationRequest: - title: Delete contextual data integration request - type: object - properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The integration id. - example: 076f4188-05e0-4ed3-afeb-653ad182ccb7 - externalDocs: - url: '' DeleteContextualDataIntegrationResponse: title: Delete contextual data integration response type: object @@ -30744,24 +26969,6 @@ components: integration. externalDocs: url: '' - DeleteCustomEnrichmentRequest: - title: Delete Custom Enrichment Request - required: - - customEnrichmentId - type: object - properties: - customEnrichmentId: - maximum: 2147483647 - minimum: 0 - type: integer - description: The unique identifier of the custom enrichment rule to delete. - format: int64 - example: 1 - description: This request data structure is used to delete a custom enrichment - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ DeleteCustomEnrichmentResponse: type: object properties: @@ -30782,19 +26989,6 @@ components: description: Response returned after successfully deleting a custom enrichment rule. externalDocs: url: '' - DeleteCustomEvaluationRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the custom evaluation to delete. - description: Request to delete a custom evaluation from the catalog. - externalDocs: - url: '' DeleteCustomEvaluationResponse: type: object properties: @@ -30808,21 +27002,6 @@ components: description: Response returned after deleting a custom evaluation. externalDocs: url: '' - DeleteCustomPresetRequest: - title: Delete Custom Preset Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: Unique identifier. - description: Request to delete a custom preset - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ DeleteCustomPresetResponse: type: object additionalProperties: false @@ -30831,29 +27010,6 @@ components: preset. externalDocs: url: '' - DeleteDashboardFolderRequest: - title: Delete dashboard folder request data structure - type: object - properties: - folderId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The folder id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the delete folder request, used to prevent - duplicate operations. - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ DeleteDashboardFolderResponse: title: Delete dashboard folder response data structure type: object @@ -30863,31 +27019,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - DeleteDashboardRequest: - title: Delete dashboard request data structure - required: - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Optional client-supplied request identifier used to correlate the - deletion request. - description: This is a request used to delete a custom dashboard - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ DeleteDashboardResponse: title: Delete dashboard response data structure type: object @@ -30938,77 +27069,18 @@ components: description: Find out more about events2metrics url: >- https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ - DeleteGlobalRouterRequest: - title: Delete Global Router Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: Unique identifier. - description: Deletes a global router with the passed identifier - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ DeleteGlobalRouterResponse: type: object additionalProperties: false description: Response returned after successfully deleting a notification router. externalDocs: url: '' - DeleteIncidentRequest: - title: Delete incident request - required: - - id - type: object - properties: - id: - minLength: 0 - type: string - description: Request to delete an incident by its ID - externalDocs: - url: '' - DeleteIntegrationRequest: - title: Delete integration request - type: object - properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the integration instance to delete. - externalDocs: - url: '' DeleteIntegrationResponse: type: object additionalProperties: false description: Response returned after successfully removing an integration instance. externalDocs: url: '' - DeleteOllyAnalysisSettingsRequest: - type: object - properties: - id: - minLength: 0 - type: string - DeleteOllyAnalysisSettingsResponse: - type: object - additionalProperties: false - DeleteOutgoingWebhookRequest: - title: Delete outgoing webhook request - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. - example: example_id - externalDocs: - url: '' DeleteOutgoingWebhookResponse: title: Delete outgoing webhook response type: object @@ -31016,25 +27088,6 @@ components: description: Response returned after successfully deleting an outgoing webhook. externalDocs: url: '' - DeletePolicyRequest: - title: Delete Policy Request - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The unique identifier of the data policy to delete. - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - description: This data structue is used to delete a policy by its ID. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ DeletePolicyResponse: title: Delete Policy Response required: @@ -31054,13 +27107,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - DeleteQuotaAllocationRuleSetRequest: - title: Delete quota allocation rule set request - type: object - additionalProperties: false - description: Request to delete quota allocation rule set - externalDocs: - url: '' DeleteQuotaAllocationRuleSetResponse: title: Delete quota allocation rule set response type: object @@ -31074,112 +27120,18 @@ components: deleted externalDocs: url: '' - DeleteRepositoriesRequest: - required: - - repositories - type: object - properties: - repositories: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 512 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9._/-]*$ - type: string - description: >- - Repositories to delete. Fails if any repository does not exist; no - repositories are deleted in that case. - description: >- - Repositories to delete. Fails if any repository does not exist; no - repositories are deleted in that case. - description: Request to delete one or more repository settings by repository. - externalDocs: - url: '' - DeleteRepositoriesResponse: - type: object - properties: - repositories: - maxItems: 1000 - minItems: 0 - type: array - items: - maxLength: 512 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9._/-]*$ - type: string - description: The repositories whose settings were deleted. - description: The repositories whose settings were deleted. - description: Response containing the repositories whose settings were deleted. - externalDocs: - url: '' - DeleteRoleRequest: - type: object - properties: - roleId: - minimum: 0 - type: integer - description: The role id. - format: int64 DeleteRoleResponse: type: object additionalProperties: false description: Response returned after successfully deleting a custom role. externalDocs: url: '' - DeleteRuleGroup: - type: object - properties: - name: - minLength: 0 - type: string - DeleteRuleGroupRequest: - type: object - properties: - groupId: - minLength: 0 - type: string - description: The unique identifier of the parsing rule group to delete. DeleteRuleGroupResponse: type: object additionalProperties: false description: Response returned after successfully deleting a parsing rule group. externalDocs: url: '' - DeleteRuleGroupSet: - title: Delete Rule Group Set - required: - - id - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - description: A matcher specifying a rule group set to delete. - externalDocs: - description: Find out more about recording rules - url: >- - https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ - DeleteScopeRequest: - title: Delete Scope Request - required: - - id - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. - example: 60c82be2-413f-4b8e-8201-7f5c51e2ef2b - description: This data structure represents a request to delete a scope - externalDocs: - description: Find out more about scopes - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ DeleteScopeResponse: type: object additionalProperties: false @@ -31214,22 +27166,6 @@ components: description: Response after deleting an existing SLO. externalDocs: url: '' - DeleteTeamGroupRequest: - title: DeleteTeamGroupRequest - type: object - properties: - groupId: - minimum: 0 - type: integer - description: The unique identifier of the team group to delete. - format: int64 - description: >- - Request to remove a team group and all its associated role and user - assignments using its unique identifier. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ DeleteTeamGroupResponse: title: DeleteTeamGroupResponse type: object @@ -31246,62 +27182,24 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - DeleteTeamRequest: - type: object - properties: - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team to delete. - description: Request to delete a team. - externalDocs: - url: '' DeleteTeamResponse: type: object additionalProperties: false description: Empty response returned after deleting a team. externalDocs: url: '' - DeleteViewFolderRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: Unique identifier for folders - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f DeleteViewFolderResponse: type: object additionalProperties: false description: Response returned after successfully deleting a view folder. externalDocs: url: '' - DeleteViewRequest: - type: object - properties: - id: - maximum: 2147483647 - minimum: 1 - type: integer - description: id - format: int32 - example: 52 DeleteViewResponse: type: object additionalProperties: false description: Response returned after successfully deleting a view. externalDocs: url: '' - DeliveriesByCaseEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/CaseNotificationDeliveries' Delivery: enum: - DELIVERY_UNSPECIFIED @@ -31406,55 +27304,6 @@ components: description: Demisto config. externalDocs: url: '' - DeployExtensionRequest: - title: Deploy extension request - type: object - properties: - applications: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The applications. - description: The applications. - extensionDeployment: - allOf: - - $ref: '#/components/schemas/ExtensionDeployment' - description: The extension deployment configuration. - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - itemIds: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The item ids. - description: The item ids. - subsystems: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The subsystems. - description: The subsystems. - version: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Version number. - externalDocs: - url: '' DeployExtensionResponse: title: Deploy extension response type: object @@ -31586,88 +27435,6 @@ components: - DESTINATION_FIELD_TEXT type: string description: Destination field. - DetailedDailyEvaluationTokens: - type: object - properties: - evaluations: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Evaluation' - description: The evaluations. - statsDate: - minLength: 0 - type: string - description: The stats date. - format: date-time - totalTokens: - $ref: '#/components/schemas/Token' - DetailedDailyProcessedGbs: - type: object - properties: - blockedGbs: - $ref: '#/components/schemas/v2.GB' - blockedMetricsGbs: - $ref: '#/components/schemas/v2.GB' - cpuProfilesGbs: - $ref: '#/components/schemas/v2.GB' - highLogsGbs: - $ref: '#/components/schemas/v2.GB' - highMetricsGbs: - $ref: '#/components/schemas/v2.GB' - highTracingGbs: - $ref: '#/components/schemas/v2.GB' - lowLogsGbs: - $ref: '#/components/schemas/v2.GB' - lowSessionRecordingGbs: - $ref: '#/components/schemas/v2.GB' - lowTracingGbs: - $ref: '#/components/schemas/v2.GB' - mediumLogsGbs: - $ref: '#/components/schemas/v2.GB' - mediumTracingGbs: - $ref: '#/components/schemas/v2.GB' - statsDate: - minLength: 0 - type: string - description: The stats date. - format: date-time - totalGbs: - $ref: '#/components/schemas/v2.GB' - DetailedDailyUnits: - type: object - properties: - blockedMetricsUnits: - $ref: '#/components/schemas/v2.Unit' - blockedUnits: - $ref: '#/components/schemas/v2.Unit' - cpuProfilesUnits: - $ref: '#/components/schemas/v2.Unit' - evaluationUnits: - $ref: '#/components/schemas/v2.Unit' - highLogsUnits: - $ref: '#/components/schemas/v2.Unit' - highMetricsUnits: - $ref: '#/components/schemas/v2.Unit' - highTracingUnits: - $ref: '#/components/schemas/v2.Unit' - lowLogsUnits: - $ref: '#/components/schemas/v2.Unit' - lowSessionRecordingUnits: - $ref: '#/components/schemas/v2.Unit' - lowTracingUnits: - $ref: '#/components/schemas/v2.Unit' - mediumLogsUnits: - $ref: '#/components/schemas/v2.Unit' - mediumTracingUnits: - $ref: '#/components/schemas/v2.Unit' - statsDate: - minLength: 0 - type: string - description: The stats date. - format: date-time - totalUnits: - $ref: '#/components/schemas/v2.Unit' Diagnostics: title: Connector Diagnostics type: object @@ -31706,55 +27473,6 @@ components: - DATA_USAGE type: string description: Digest type. - Dimension: - type: object - oneOf: - - required: - - pillar - type: object - - required: - - genericDimension - type: object - - required: - - tier - type: object - - required: - - severity - type: object - - required: - - priority - type: object - - type: object - not: - anyOf: - - required: - - pillar - type: object - - required: - - genericDimension - type: object - - required: - - tier - type: object - - required: - - severity - type: object - - required: - - priority - type: object - properties: - genericDimension: - $ref: '#/components/schemas/GenericDimension' - pillar: - $ref: '#/components/schemas/v2.Pillar' - priority: - $ref: '#/components/schemas/v2.Priority' - severity: - $ref: '#/components/schemas/datausage.v2.Severity' - tier: - allOf: - - $ref: '#/components/schemas/v2.TcoTier' - deprecated: true DimensionAggregation: type: object properties: @@ -31869,38 +27587,6 @@ components: backed by either an observation field or mapped values externalDocs: url: '' - DownloadAlertsRequest: - title: Download alert definitions request - type: object - properties: - ids: - maxItems: 1000 - minItems: 0 - type: array - items: - maxLength: 36 - minLength: 0 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: >- - Optional list of alert definition IDs to download. When empty, all - accessible alert definitions are downloaded. IDs that are not - found or not accessible are omitted from the download and reported - in the response notFoundIds (no error is returned for them). - description: >- - Optional list of alert definition IDs to download. When empty, all - accessible alert definitions are downloaded. IDs that are not found - or not accessible are omitted from the download and reported in the - response notFoundIds (no error is returned for them). - example: - - 123e4567-e89b-12d3-a456-426614174000 - description: >- - A request to download accessible alert definitions in base-64 encoded - binary format. When ids are provided, only those alert definitions are - downloaded; otherwise all accessible alert definitions are downloaded. - externalDocs: - url: '' DownloadAlertsResponse: title: Download alerts response type: object @@ -32016,20 +27702,6 @@ components: description: Query definition for dynamic widget externalDocs: url: '' - DynamicAlertMatch: - type: object - properties: - forecastTimestamp: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - observedDetails: - $ref: '#/components/schemas/ObservedDetails' - searchDetails: - $ref: '#/components/schemas/v3.SearchDetails' - topBucket: - $ref: '#/components/schemas/TopBucket' E2M: title: E2M required: @@ -32341,9 +28013,6 @@ components: description: Email group config. externalDocs: url: '' - Empty: - type: object - additionalProperties: false EnabledCount: title: Enabled count type: object @@ -32622,27 +28291,6 @@ components: filter. externalDocs: url: '' - EntityLabelMatcherEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - EntityLabelValues: - type: object - properties: - values: - maxItems: 100 - minItems: 1 - type: array - items: - minLength: 0 - type: string - description: The values. - description: The values. EntityLink: title: Entity link required: @@ -32766,14 +28414,6 @@ components: type: string description: Human-readable description of the error. description: Standard error response body returned for a failed request. - ErrorBudgetAlertDefinition: - type: object - additionalProperties: false - ErrorBudgetMetricType: - type: object - properties: - metricFilter: - $ref: '#/components/schemas/SloMetricFilter' ErrorBudgetThreshold: title: Error Budget Threshold type: object @@ -32788,32 +28428,6 @@ components: description: Error budget threshold definition externalDocs: url: '' - ErrorDetails: - type: object - properties: - cardinality: - minimum: 0 - type: integer - format: int64 - limit: - minimum: 0 - type: integer - format: int64 - ErrorType: - enum: - - ERROR_TYPE_UNSPECIFIED - - GENERAL - - CARDINALITY_LIMIT_EXCEEDED - type: string - Evaluation: - type: object - properties: - evaluationTokens: - $ref: '#/components/schemas/Token' - evaluatorName: - minLength: 0 - type: string - description: The evaluator name. EvaluationConfig: type: object oneOf: @@ -33100,342 +28714,6 @@ components: description: Actor that initiated the event. externalDocs: url: '' - EventFlow: - type: object - properties: - flowAlertsMatch: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EventFlowMatch' - EventFlowMatch: - type: object - properties: - from: - minLength: 0 - type: string - description: The from. - format: date-time - groups: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FlowGroupEvents' - description: Groups. - to: - minLength: 0 - type: string - description: The to. - format: date-time - EventMetricEquals: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - isDeadman: - type: boolean - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricLessThan: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - isDeadman: - type: boolean - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricLessThanOrEquals: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - isDeadman: - type: boolean - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricMoreThan: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricMoreThanOrEquals: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricNotEquals: - type: object - properties: - avgValueAcrossThreshold: - type: number - format: float - fromTimestamp: - minLength: 0 - type: string - format: date-time - isDeadman: - type: boolean - maxValueAcrossThreshold: - type: number - format: float - minValueAcrossThreshold: - type: number - format: float - percentageOverThreshold: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventMetricUnusualPayload: - type: object - properties: - distance: - type: number - format: double - extremeSample: - $ref: '#/components/schemas/v5.ExtremeSample' - forecastTimestamp: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - ratioUnusualSamples: - type: number - format: double - searchDetails: - $ref: '#/components/schemas/TimeRangeWithInterval' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventNewValue: - type: object - properties: - coralogixLogMetadata: - $ref: '#/components/schemas/CoralogixLogMetadata' - logRecord: - minLength: 0 - type: string - logTimestamp: - minLength: 0 - type: string - format: date-time - EventNotificationsInstance: - type: object - properties: - crn: - minLength: 0 - type: string - example: >- - crn:v1:staging:public:logs:eu-gb:a/436fa6f7760f46eba99e22f099c33cb8:5a8b249b-3915-49e7-ad43-030f585d84c5:: - instanceId: - minLength: 0 - type: string - example: 5a8b249b-3915-49e7-ad43-030f585d84c5 - isUsed: - type: boolean - example: true - name: - minLength: 0 - type: string - example: example-name - regionId: - minLength: 0 - type: string - example: eu-gb - EventRatioLessThan: - type: object - oneOf: - - required: - - numeric - type: object - - required: - - special - type: object - - type: object - not: - anyOf: - - required: - - numeric - type: object - - required: - - special - type: object - properties: - denominatorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - numeratorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - numeric: - type: number - format: float - severity: - allOf: - - $ref: '#/components/schemas/AlertDefSeverity' - description: Severity. - special: - $ref: '#/components/schemas/SpecialRatioValues' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventRatioMoreThan: - type: object - oneOf: - - required: - - numeric - type: object - - required: - - special - type: object - - type: object - not: - anyOf: - - required: - - numeric - type: object - - required: - - special - type: object - properties: - denominatorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - numeratorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - numeric: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - special: - $ref: '#/components/schemas/SpecialRatioValues' - toTimestamp: - minLength: 0 - type: string - format: date-time EventRecurrenceSource: type: object properties: @@ -33518,145 +28796,6 @@ components: start hour. externalDocs: url: '' - EventStandardEquals: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - hitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - isDeadman: - type: boolean - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventStandardImmediate: - type: object - properties: - coralogixLogMetadata: - $ref: '#/components/schemas/CoralogixLogMetadata' - logRecord: - minLength: 0 - type: string - logTimestamp: - minLength: 0 - type: string - format: date-time - EventStandardLessThan: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - hitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - isDeadman: - type: boolean - severity: - allOf: - - $ref: '#/components/schemas/AlertDefSeverity' - description: Severity. - toTimestamp: - minLength: 0 - type: string - format: date-time - EventStandardLessThanUsual: - type: object - properties: - lessThanUsual: - $ref: '#/components/schemas/EventStandardUnusualPayload' - EventStandardLessThanUsualEnriched: - type: object - properties: - eventStandardLessThanUsual: - $ref: '#/components/schemas/EventStandardLessThanUsual' - prediction: - $ref: '#/components/schemas/v5.Prediction' - EventStandardMoreThan: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - hitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - severity: - allOf: - - $ref: '#/components/schemas/AlertDefSeverity' - description: Severity. - toTimestamp: - minLength: 0 - type: string - format: date-time - EventStandardMoreThanUsualEnriched: - type: object - properties: - eventStandardMoreThanUsual: - $ref: '#/components/schemas/v5.EventStandardMoreThanUsual' - prediction: - $ref: '#/components/schemas/v5.Prediction' - EventStandardNotEquals: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - hitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - isDeadman: - type: boolean - severity: - $ref: '#/components/schemas/AlertDefSeverity' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventStandardUnusualPayload: - type: object - properties: - distance: - type: number - format: double - forecastTimestamp: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - searchDetails: - $ref: '#/components/schemas/TimeRangeWithInterval' - sumHitCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - toTimestamp: - minLength: 0 - type: string - format: date-time EventStats: title: Alert event statistics data structure type: object @@ -33697,277 +28836,6 @@ components: description: The triggered permutations samples. externalDocs: url: '' - EventTimeRelativeLessThan: - type: object - oneOf: - - required: - - numeric - type: object - - required: - - special - type: object - - type: object - not: - anyOf: - - required: - - numeric - type: object - - required: - - special - type: object - properties: - denominatorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - numeratorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - numeric: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - special: - $ref: '#/components/schemas/SpecialRatioValues' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventTimeRelativeMoreThan: - type: object - oneOf: - - required: - - numeric - type: object - - required: - - special - type: object - - type: object - not: - anyOf: - - required: - - numeric - type: object - - required: - - special - type: object - properties: - denominatorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - numeratorHitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - numeric: - type: number - format: float - severity: - $ref: '#/components/schemas/AlertDefSeverity' - special: - $ref: '#/components/schemas/SpecialRatioValues' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventTracingImmediate: - type: object - properties: - span: - $ref: '#/components/schemas/v3.Span' - timeRange: - $ref: '#/components/schemas/SpanTimeRange' - traceIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - EventTracingMoreThan: - type: object - properties: - countersMap: - type: object - additionalProperties: - minimum: 0 - type: integer - format: int64 - timeRange: - $ref: '#/components/schemas/SpanTimeRange' - EventTracingMoreThan.CountersMapEntry: - type: object - properties: - key: - minimum: 0 - type: integer - format: int64 - value: - minimum: 0 - type: integer - format: int64 - EventUniqueCount: - type: object - properties: - alertTimeframe: - minimum: 0 - type: integer - format: int64 - cardinalityKey: - minLength: 0 - type: string - countersMap: - type: object - additionalProperties: - minimum: 0 - type: integer - format: int64 - valuesSet: - minItems: 0 - type: array - items: - minLength: 0 - type: string - windowStartTimeframeMs: - minLength: 0 - type: string - format: date-time - EventUniqueCount.CountersMapEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minimum: 0 - type: integer - format: int64 - EventUnusualPayload: - type: object - properties: - distance: - type: number - format: double - extremeSample: - $ref: '#/components/schemas/v4.ExtremeSample' - forecastTimestamp: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - ratioUnusualSamples: - type: number - format: double - searchDetails: - $ref: '#/components/schemas/v4.SearchDetails' - toTimestamp: - minLength: 0 - type: string - format: date-time - EventsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/CxEventSingleOrMultiple' - EventsFilter: - title: EventsFilter - required: - - timestamp - - cxEventTypes - - cxEventKeys - type: object - properties: - cxEventKeys: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: >- - List of event attribute keys to include when retrieving event - data. - description: List of event attribute keys to include when retrieving event data. - example: - - test_key - cxEventLabelsFilters: - allOf: - - $ref: '#/components/schemas/Filters' - description: Filters applied to event label fields. - cxEventMetadataFilters: - allOf: - - $ref: '#/components/schemas/Filters' - description: Filters applied to event metadata fields. - cxEventTypes: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of event type identifiers to include in the results. - description: List of event type identifiers to include in the results. - example: - - test_type - timestamp: - allOf: - - $ref: '#/components/schemas/TimestampRange' - description: Time range to filter events by their occurrence timestamp. - description: This data structure represents an events filter - externalDocs: - url: '' - EventsQueryFilter: - type: object - properties: - timestamp: - allOf: - - $ref: '#/components/schemas/TimestampRange' - description: Time range to filter events by their occurrence timestamp. - EventsStatsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/EventStats' - ExecStats: - type: object - properties: - count: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - rateOfTotal: - type: number - format: float - ExecStatus: - enum: - - SUCCESS - - UNCATEGORIZED - - TIMEOUT - - LIMIT_VIOLATION - type: string ExtensionBinary: title: Extension binary type: object @@ -33987,120 +28855,6 @@ components: - KIBANA_INDEX_PATTERN type: string description: Type of binary content stored in the extension. - ExtensionData: - title: Extension data - type: object - properties: - binaries: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtensionBinary' - description: The binaries. - changelog: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ChangelogEntry' - description: The changelog. - darkModeImage: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The dark mode image. - deprecation: - $ref: '#/components/schemas/Deprecation' - description: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - example: Integration with AWS CloudWatch for monitoring and logging - excerpt: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The excerpt. - example: Monitor AWS resources and analyze logs with CloudWatch integration - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - example: 076f4188-05e0-4ed3-afeb-653ad182ccb7 - image: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Image reference. - integrationDetails: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/IntegrationDetail' - description: The integration details. - integrations: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The integrations. - description: The integrations. - isHidden: - type: boolean - description: The is hidden. - items: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtensionItemData' - description: List of items. - keywords: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The keywords. - description: The keywords. - labels: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of labels. - description: List of labels. - name: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Display name. - example: AWS CloudWatch Extension - version: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Version number. - example: v1.0.13 - description: Extension details for ingestion - externalDocs: - url: '' ExtensionDeployment: title: Extension deployment type: object @@ -34235,61 +28989,6 @@ components: - CX_CUSTOM_DASHBOARD_DEFINITION type: string description: Binary type. - ExtensionItemData: - title: Extension item data - type: object - properties: - binaries: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtensionItemBinary' - description: The binaries. - data: - type: object - description: Data payload. - description: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - example: Less than 60% cocoa - internalId: - maximum: 2147483647 - minimum: -2147483648 - type: integer - description: The internal id. - format: int32 - isMandatory: - type: boolean - description: The is mandatory. - name: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Display name. - example: Low cocoa content - permissionResource: - $ref: '#/components/schemas/PermissionResource' - stableId: - maxLength: 63 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The stable id. - targetDomain: - $ref: '#/components/schemas/TargetDomain' - uniqueId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique id. - externalDocs: - url: '' ExtensionRevision: title: Extension revision type: object @@ -34377,55 +29076,6 @@ components: description: Extract parameters. externalDocs: url: '' - ExtractRequest: - type: object - oneOf: - - required: - - log - type: object - - required: - - span - type: object - - type: object - not: - anyOf: - - required: - - log - type: object - - required: - - span - type: object - properties: - ctxDataSourceType: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - destinationDataSourceTypes: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceType' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - log: - $ref: '#/components/schemas/Log' - span: - $ref: '#/components/schemas/v1.Span' - ExtractResponse: - type: object - properties: - extractedLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtractedLabel' ExtractTimestampParameters: type: object properties: @@ -34438,47 +29088,6 @@ components: description: Extract timestamp parameters. externalDocs: url: '' - ExtractedLabel: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - description: - minLength: 0 - type: string - description: Human-readable description. - destinationExtractionKey: - minLength: 0 - type: string - deprecated: true - destinationExtractionKeys: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - destinationTypeExtractionKeys: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceTypeValues' - displayName: - minLength: 0 - type: string - description: The display name. - isCustomLabel: - type: boolean - label: - minLength: 0 - type: string - values: - minItems: 0 - type: array - items: - minLength: 0 - type: string FailedItem: title: Failed item type: object @@ -34579,48 +29188,8 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - FetchJobRequest: - type: object - properties: - jobDefinition: - $ref: '#/components/schemas/JobDefinition' - FetchJobResponse: - type: object - properties: - analysisResult: - $ref: '#/components/schemas/AnalysisResult' - jobStatus: - $ref: '#/components/schemas/JobStatus' - FetchRuleGroup: - type: object - properties: - name: - minLength: 0 - type: string - FetchRuleGroupResult: - type: object - properties: - ruleGroup: - $ref: '#/components/schemas/OutRuleGroup' - FetchRuleGroupSet: - title: Fetch Rule Group Set - required: - - id - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - description: A matcher specifying a rule group set to fetch. - externalDocs: - description: Find out more about recording rules - url: >- - https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ - FieldCondition: - title: Field condition + FieldCondition: + title: Field condition type: object properties: type: @@ -34674,16 +29243,6 @@ components: - FIELD_DATA_TYPE_ENUM type: string description: Field data type. - FieldGroup: - type: object - properties: - name: - minLength: 0 - type: string - description: Display name. - value: - minLength: 0 - type: string FieldInformation: title: Field information type: object @@ -34831,17 +29390,6 @@ components: pattern: ^-?[0-9]+$ type: string description: The field statistics. - FieldStatisticsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string FieldType: enum: - FIELD_TYPE_UNSPECIFIED @@ -35118,29 +29666,6 @@ components: description: Count of cases matching a single key/value filter combination. externalDocs: url: '' - FilterByAlertSchedulerRuleIds: - type: object - oneOf: - - required: - - alertSchedulerIds - type: object - - required: - - alertSchedulerVersionIds - type: object - - type: object - not: - anyOf: - - required: - - alertSchedulerIds - type: object - - required: - - alertSchedulerVersionIds - type: object - properties: - alertSchedulerIds: - $ref: '#/components/schemas/AlertSchedulerRuleIds' - alertSchedulerVersionIds: - $ref: '#/components/schemas/AlertSchedulerRuleVersionIds' FilterGroup: title: Filter group required: @@ -35267,46 +29792,6 @@ components: description: Filter by alert definition entity labels with And/Or options externalDocs: url: '' - FilterOptionCountsEntityLabelsFilter.EntityLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - FilterOptionCountsFilter: - title: Filter option counts filter - type: object - properties: - enabledFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsEnabledFilter' - description: Filter by alert definition enabled status - entityLabelsFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsEntityLabelsFilter' - description: Filter by alert definition entity labels - nameFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsNameFilter' - description: Filter by alert definition names - priorityFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsPriorityFilter' - description: Filter by alert definition priorities - statusFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsStatusFilter' - description: Filter by alert definition status - typeFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsTypeFilter' - description: Filter by alert definition types - description: Filter configuration for counting filter options - externalDocs: - url: '' FilterOptionCountsNameFilter: title: Filter option counts name filter type: object @@ -35355,17 +29840,6 @@ components: description: Filter by alert definition priorities externalDocs: url: '' - FilterOptionCountsRequest: - title: Filter option counts request - type: object - properties: - queryFilter: - allOf: - - $ref: '#/components/schemas/FilterOptionCountsFilter' - description: The filter to apply when counting options - description: Request to get counts for filter options based on applied filters - externalDocs: - url: '' FilterOptionCountsResponse: title: Filter option counts response type: object @@ -35475,28 +29949,6 @@ components: description: First. externalDocs: url: '' - FlowGroupEvents: - type: object - properties: - events: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AlertEventOut' - resolvedAlerts: - minItems: 0 - type: array - items: - minLength: 0 - type: string - FlowNotification: - type: object - properties: - flowAlertMatch: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EventFlowMatch' FlowStages: title: Flow stages type: object @@ -35611,80 +30063,6 @@ components: description: Folder path. externalDocs: url: '' - ForecastPolicyUsageRequest: - title: Forecast Policy Usage Request - type: object - allOf: - - oneOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - - type: object - not: - anyOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - - oneOf: - - required: - - day - type: object - - required: - - week - type: object - - type: object - not: - anyOf: - - required: - - day - type: object - - required: - - week - type: object - properties: - applicationRule: - $ref: '#/components/schemas/quota.v1.Rule' - day: - $ref: '#/components/schemas/Day' - logRules: - $ref: '#/components/schemas/LogRules' - rumRules: - $ref: '#/components/schemas/LogRules' - spanRules: - $ref: '#/components/schemas/SpanRules' - subsystemRule: - $ref: '#/components/schemas/quota.v1.Rule' - timeBucketMs: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: >- - Optional bucket size, in milliseconds, used to split the forecast - into time buckets. When set, the response includes a per-bucket - breakdown in usage_buckets; when omitted, only the total estimated - bytes are returned. - example: '3600000' - week: - $ref: '#/components/schemas/Week' - description: >- - Request to forecast the usage in bytes of a draft TCO policy, based on - the bytes matched by its filter rules over a given time window. - externalDocs: - description: Find out more about DPXL expressions. - url: https://coralogix.com/docs/dataprime/user-guide/dpxl/ ForecastPolicyUsageResponse: title: Forecast Policy Usage Response required: @@ -35716,57 +30094,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - Format: - type: object - oneOf: - - required: - - logsAvro - type: object - - required: - - spansAvro - type: object - - required: - - genericEventAvro - type: object - - required: - - wideParquet - type: object - - required: - - csv - type: object - - type: object - not: - anyOf: - - required: - - logsAvro - type: object - - required: - - spansAvro - type: object - - required: - - genericEventAvro - type: object - - required: - - wideParquet - type: object - - required: - - csv - type: object - properties: - csv: - $ref: '#/components/schemas/Csv' - genericEventAvro: - $ref: '#/components/schemas/GenericEventAvro' - logsAvro: - allOf: - - $ref: '#/components/schemas/LogsAvro' - deprecated: true - spansAvro: - allOf: - - $ref: '#/components/schemas/SpansAvro' - deprecated: true - wideParquet: - $ref: '#/components/schemas/WideParquet' FormatStandard: enum: - FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED @@ -35778,13 +30105,6 @@ components: - FORMAT_STANDARD_NANOTS type: string description: Format standard. - FullDataprimeQuery: - type: object - properties: - raw: - $ref: '#/components/schemas/common.DataprimeQuery' - serialized: - $ref: '#/components/schemas/SerializedDataprimeQuery' Gauge.Aggregation: enum: - AGGREGATION_UNSPECIFIED @@ -36047,30 +30367,6 @@ components: description: Find out more about metrics cost optimization url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ - GenericDimension: - title: Generic Dimension - type: object - properties: - key: - minLength: 0 - type: string - description: The key. - example: key - value: - minLength: 0 - type: string - description: The value. - example: value - description: This data structure represents a generic dimension. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GenericEventAvro: - type: object - properties: - version: - $ref: '#/components/schemas/generic.v1.Version' GenericIndicator: title: Generic indicator required: @@ -36485,19 +30781,6 @@ components: description: Geomap tooltip. externalDocs: url: '' - GetActionRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier. - description: This data structure represents the request to get an Action. - externalDocs: - url: '' GetActionResponse: type: object properties: @@ -36506,12 +30789,6 @@ components: description: This data structure represents the response to get an Action. externalDocs: url: '' - GetActiveCaseSettingsRequest: - title: Get active case settings request - type: object - additionalProperties: false - externalDocs: - url: '' GetActiveCaseSettingsResponse: title: Get active case settings response required: @@ -36527,35 +30804,6 @@ components: active for the caller. externalDocs: url: '' - GetActiveOllyAnalysisSettingsRequest: - type: object - additionalProperties: false - GetActiveOllyAnalysisSettingsResponse: - type: object - properties: - ollyAnalysisSettings: - $ref: '#/components/schemas/OllyAnalysisSettings' - GetAdaptiveRulesRequest: - type: object - additionalProperties: false - GetAdaptiveRulesResponse: - type: object - properties: - rules: - $ref: '#/components/schemas/AdaptiveRules' - GetAiApplicationByIdRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI application. - description: Request to fetch a single AI application by id. - externalDocs: - url: '' GetAiApplicationByIdResponse: type: object properties: @@ -36566,44 +30814,6 @@ components: description: Response containing the requested AI application. externalDocs: url: '' - GetAiCenterCodeAgentsRequest: - type: object - additionalProperties: false - description: >- - Request to get the code agents already marked as successfully - integrated. Team is resolved from auth context. - externalDocs: - url: '' - GetAiCenterCodeAgentsResponse: - type: object - properties: - codeAgents: - maxItems: 50 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CodeAgentIntegration' - description: >- - The code agents marked as successfully integrated, each with its - marked integration types. - description: >- - Response containing the code agents already marked as successfully - integrated, each with its marked integration types. - externalDocs: - url: '' - GetAiEvaluationRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI evaluation. - description: Request to fetch an AI evaluation by id. - externalDocs: - url: '' GetAiEvaluationResponse: type: object properties: @@ -36614,26 +30824,6 @@ components: description: Response containing the requested AI evaluation. externalDocs: url: '' - GetAlertDefByVersionIdRequest: - title: Get alert definition by version ID request - type: object - properties: - alertVersionId: - maxLength: 36 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Alert version ID - example: 123e4567-e89b-12d3-a456-426614174000 - includeAccessPermissions: - type: boolean - description: >- - When true, populate the response's access field with the caller's - access decision and the alert's raw access policy. Defaults to - false. - description: A request to retrieve an alert definition by version ID - externalDocs: - url: '' GetAlertDefByVersionIdResponse: title: Get alert definition by version ID response type: object @@ -36649,27 +30839,6 @@ components: description: A response that contains an alert definition for the requested version externalDocs: url: '' - GetAlertDefRequest: - title: Get alert definition request - type: object - properties: - id: - maxLength: 36 - minLength: 0 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Alert definition ID - example: 123e4567-e89b-12d3-a456-426614174000 - includeAccessPermissions: - type: boolean - description: >- - When true, populate the response's access field with the caller's - access decision and the alert's raw access policy. Defaults to - false. - description: A request to retrieve an alert definition by ID - externalDocs: - url: '' GetAlertDefResponse: title: Get alert definition response type: object @@ -36685,31 +30854,6 @@ components: description: A response containing the requested alert definition externalDocs: url: '' - GetAlertEventRequest: - title: Get alert event by ID request - type: object - properties: - id: - maxLength: 36 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - orderBys: - maxItems: 20 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AlertEventOrderBy' - description: Ordering applied to the alert event occurrences in the response. - pagination: - allOf: - - $ref: '#/components/schemas/alerts.v3.PaginationRequest' - description: >- - Pagination parameters (page size and page token) for the returned - occurrences. - externalDocs: - url: '' GetAlertEventResponse: title: Get alert event response type: object @@ -36745,30 +30889,6 @@ components: description: Response containing the details of an alert event. externalDocs: url: '' - GetAlertEventStatsRequest: - title: Get alert event statistics request - type: object - properties: - ids: - maxItems: 1000 - minItems: 0 - type: array - items: - maxLength: 36 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The ids. - description: The ids. - orderBys: - maxItems: 20 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AlertEventOrderBy' - description: The order bys. - externalDocs: - url: '' GetAlertEventStatsResponse: title: Get alert event statistics response type: object @@ -36781,21 +30901,6 @@ components: description: Response containing statistical data for alert events. externalDocs: url: '' - GetAlertSchedulerRuleRequest: - title: Get alert scheduler rule request data structure - required: - - alertSchedulerRuleId - type: object - properties: - alertSchedulerRuleId: - minLength: 0 - type: string - description: The unique identifier of the alert scheduler (suppression) rule. - description: This is a request sent to get an alert scheduler rule - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ GetAlertSchedulerRuleResponse: title: Get alert scheduler rule response data structure required: @@ -36809,20 +30914,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - GetAllExtensionsRequest: - title: Get all extensions request - type: object - properties: - filter: - $ref: '#/components/schemas/GetAllExtensionsRequest.Filter' - includeHiddenExtensions: - type: boolean - description: >- - Whether to include hidden extensions that are not publicly listed in - the catalog. - description: Request to list all extensions - externalDocs: - url: '' GetAllExtensionsRequest.Filter: title: A filter structure for a request to get all extensions type: object @@ -36967,20 +31058,6 @@ components: description: Revision summary. externalDocs: url: '' - GetApiKeyRequest: - title: Get Api Key Request - type: object - properties: - keyId: - minLength: 0 - type: string - description: Key identifier. - example: my_key_id - description: This data structure is used to retrieve an API key. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ GetApiKeyResponse: title: Get Api Key Response type: object @@ -36992,9 +31069,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - GetApiKeysRequest: - type: object - additionalProperties: false GetApiKeysResponse: title: Get Api Keys Response type: object @@ -37012,34 +31086,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - GetBulkAlertSchedulerRuleRequest: - title: Get bulk alert scheduler rule request data structure - type: object - properties: - activeTimeframe: - allOf: - - $ref: '#/components/schemas/ActiveTimeframe' - description: >- - Active timeframe filter to limit results to rules active in the - given window. - alertSchedulerRulesIds: - allOf: - - $ref: '#/components/schemas/FilterByAlertSchedulerRuleIds' - description: >- - Filter results to the specified alert scheduler rule or rule version - IDs. - enabled: - type: boolean - description: Whether this resource is enabled. - nextPageToken: - minLength: 0 - type: string - description: Token for fetching the next page of results. - description: This is a request sent to get multiple alert scheduler rules - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ GetBulkAlertSchedulerRuleResponse: title: Get bulk alert scheduler rule response data structure required: @@ -37061,34 +31107,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - GetCaseAlertEventIdsRequest: - type: object - properties: - caseId: - minLength: 0 - type: string - count: - minimum: 0 - type: integer - format: int64 - GetCaseAlertEventIdsResponse: - type: object - properties: - eventIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetCaseByIndicatorRequest: - title: Get case by indicator request - type: object - properties: - prometheusAlert: - $ref: '#/components/schemas/PrometheusAlertManagerIndicator' - description: Request to retrieve a case associated with a given alert indicator. - externalDocs: - url: '' GetCaseByIndicatorResponse: title: Get case by indicator response required: @@ -37102,25 +31120,6 @@ components: description: Response containing the case associated with the given indicator. externalDocs: url: '' - GetCaseDeepLinksRequest: - title: Get case deep links request - required: - - caseId - type: object - properties: - caseId: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case. Accepts either the case UUID (the `id` field on a - case) or the readable identifier (the `readable_id` field, e.g. - `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' GetCaseDeepLinksResponse: title: Get case deep links response required: @@ -37134,25 +31133,6 @@ components: description: Response containing the deep links for the requested case externalDocs: url: '' - GetCaseRequest: - title: Get case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case. Accepts either the case UUID (the `id` field on a - case) or the readable identifier (the `readable_id` field, e.g. - `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' GetCaseResponse: title: Get case response required: @@ -37166,21 +31146,6 @@ components: description: Response containing the requested case externalDocs: url: '' - GetCaseSettingsRequest: - title: Get case settings request - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: ID of the case settings team configuration - example: 8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321 - externalDocs: - url: '' GetCaseSettingsResponse: title: Get case settings response required: @@ -37194,45 +31159,6 @@ components: description: Response containing the requested case settings team configuration. externalDocs: url: '' - GetCasesByAlertEventIdRequest: - type: object - properties: - alertEventId: - minLength: 0 - type: string - GetCasesByAlertEventIdResponse: - type: object - properties: - cases: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Case' - GetCompanyDataSourcesInternalRequest: - type: object - additionalProperties: false - GetCompanyDataSourcesInternalResponse: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - GetCompanyDataSourcesRequest: - type: object - additionalProperties: false - GetCompanyDataSourcesResponse: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - GetCompanyEnrichmentSettingsRequest: - type: object - additionalProperties: false GetCompanyEnrichmentSettingsResponse: type: object properties: @@ -37241,21 +31167,6 @@ components: description: Response containing the company-level enrichment settings. externalDocs: url: '' - GetCompanyIpAccessSettingsRequest: - title: Get company IP access settings request - type: object - properties: - id: - minLength: 0 - type: string - description: >- - The ID of the company IP access settings to get. If it's not - provided, the id will be derived from the authorization header. - description: >- - This data structure represents the request to get company IP access - settings. - externalDocs: - url: '' GetCompanyIpAccessSettingsResponse: title: Get company IP access settings response type: object @@ -37269,14 +31180,6 @@ components: settings. externalDocs: url: '' - GetCompanyModelPricingRequest: - type: object - additionalProperties: false - description: >- - Request to get the company's custom model pricing. Company is resolved - from auth context. - externalDocs: - url: '' GetCompanyModelPricingResponse: type: object properties: @@ -37287,23 +31190,6 @@ components: description: Response containing the company's custom model pricing. externalDocs: url: '' - GetCompanyPoliciesRequest: - title: Get Company Policies Request - type: object - properties: - enabledOnly: - type: boolean - description: When true, return only policies that are currently enabled. - example: true - sourceType: - allOf: - - $ref: '#/components/schemas/v1.SourceType' - description: Filter policies by data source type (for example logs or spans). - description: This data structue is used to retrieve all company policies. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ GetCompanyPoliciesResponse: title: Get Company Policies Response required: @@ -37324,21 +31210,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - GetCompanyProvidersRequest: - type: object - additionalProperties: false - GetCompanyProvidersResponse: - type: object - properties: - companyProviders: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetCompanyUsageLimitsRequest: - type: object - additionalProperties: false GetCompanyUsageLimitsResponse: type: object properties: @@ -37353,50 +31224,6 @@ components: description: Response containing the company-level rule usage limits. externalDocs: url: '' - GetConfigurationGroupRequest: - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Configuration group UUID v7. - latestFamilyOnly: - type: boolean - description: Return only the latest configuration family when true. - description: Request to retrieve a fleet-manager configuration group. - externalDocs: - url: '' - GetConfigurationGroupResponse: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/ConfigurationGroup' - description: Requested configuration group. - description: Response containing the requested fleet-manager configuration group. - externalDocs: - url: '' - GetConfigurationRequest: - title: Get Configuration Request - type: object - properties: - teamId: - minimum: 0 - type: integer - description: >- - The unique identifier of the team whose SAML configuration to - retrieve. - format: int64 - description: >- - This data structure is used to retrieve the configuration of a SAML - service provider and identity provider - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ GetConfigurationResponse: title: Get Configuration Response type: object @@ -37419,21 +31246,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - GetConnectorRequest: - title: Get Connector Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the connector. - description: Request to retrieve a connector - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ GetConnectorResponse: title: Get Connector Response type: object @@ -37445,13 +31257,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GetConnectorSchemaRequest: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: Connector type whose schema to retrieve. GetConnectorSchemaResponse: type: object properties: @@ -37462,47 +31267,6 @@ components: type. externalDocs: url: '' - GetConnectorSummaryRequest: - title: Get Connector Summary Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the connector. - description: Request to retrieve a secret-free connector summary - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GetConnectorSummaryResponse: - title: Get Connector Summary Response - type: object - properties: - connectorSummary: - allOf: - - $ref: '#/components/schemas/ConnectorSummary' - description: The requested connector summary. - description: Response containing the requested connector summary - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GetConnectorTypeSummariesRequest: - title: Get Connector Type Summaries Request - type: object - properties: - supportedByEntityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Filter connector types by the entity type they support. - description: Request to retrieve summaries of connector types - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ GetConnectorTypeSummariesResponse: title: Get Connector Type Summaries Response type: object @@ -37519,21 +31283,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GetContextualDataIntegrationDefinitionRequest: - title: Get contextual data integration definition request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the contextual data integration definition. - includeTestingIntegrations: - type: boolean - description: Whether to include testing integrations in the results. - externalDocs: - url: '' GetContextualDataIntegrationDefinitionResponse: title: Get contextual data integration definition response type: object @@ -37545,22 +31294,6 @@ components: type. externalDocs: url: '' - GetContextualDataIntegrationDetailsRequest: - title: Get contextual data integration details request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the contextual data integration. - example: 076f4188-05e0-4ed3-afeb-653ad182ccb7 - includeTestingRevisions: - type: boolean - description: Whether to include testing revisions in the results. - externalDocs: - url: '' GetContextualDataIntegrationDetailsResponse: title: Get contextual data integration details response type: object @@ -37570,15 +31303,6 @@ components: description: Response containing the details of a contextual data integration. externalDocs: url: '' - GetContextualDataIntegrationsRequest: - title: Get contextual data integrations request - type: object - properties: - includeTestingIntegrations: - type: boolean - description: Whether to include testing integrations in the results. - externalDocs: - url: '' GetContextualDataIntegrationsResponse: title: Get contextual data integrations response type: object @@ -37626,22 +31350,6 @@ components: description: The upgrade available. externalDocs: url: '' - GetCustomEnrichmentRequest: - title: Get Custom Enrichment Request - type: object - properties: - id: - maximum: 2147483647 - minimum: 0 - type: integer - description: The unique identifier of the custom enrichment rule. - format: int64 - example: 1 - description: This is used to retrieve a custom enrichment by id - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ GetCustomEnrichmentResponse: title: Get Custom Enrichment Response required: @@ -37657,9 +31365,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - GetCustomEnrichmentsRequest: - type: object - additionalProperties: false GetCustomEnrichmentsResponse: title: Get Custom Enrichments Response type: object @@ -37678,12 +31383,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - GetCustomEvaluationsRequest: - type: object - additionalProperties: false - description: Request to list all custom evaluations in the catalog. - externalDocs: - url: '' GetCustomEvaluationsResponse: type: object properties: @@ -37697,41 +31396,6 @@ components: description: Response containing the custom evaluations in the catalog. externalDocs: url: '' - GetCustomLabelMappingsRequest: - type: object - properties: - dataSourceTypes: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetCustomLabelMappingsResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - GetCustomRoleRequest: - type: object - properties: - roleId: - minimum: 0 - type: integer - description: The role id. - format: int64 GetCustomRoleResponse: type: object properties: @@ -37740,139 +31404,6 @@ components: description: Response containing the details of a custom role. externalDocs: url: '' - GetDailyUsageEvaluationTokensRequest: - type: object - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - type: object - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - description: Request for daily evaluation token usage data for the specified period. - externalDocs: - url: '' - GetDailyUsageEvaluationTokensResponse: - type: object - properties: - tokens: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DetailedDailyEvaluationTokens' - description: List of tokens. - description: Response containing daily evaluation token usage data. - externalDocs: - url: '' - GetDailyUsageProcessedGbsRequest: - type: object - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - type: object - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - description: >- - Request for daily processed gigabytes usage data for the specified - period. - externalDocs: - url: '' - GetDailyUsageProcessedGbsResponse: - type: object - properties: - gbs: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DetailedDailyProcessedGbs' - description: The gbs. - description: Response containing daily processed gigabytes usage data. - externalDocs: - url: '' - GetDailyUsageUnitsRequest: - type: object - oneOf: - - required: - - range - type: object - - required: - - dateRange - type: object - - type: object - not: - anyOf: - - required: - - range - type: object - - required: - - dateRange - type: object - properties: - dateRange: - $ref: '#/components/schemas/v2.DateRange' - range: - $ref: '#/components/schemas/v2.Range' - description: Request for daily units usage data for the specified period. - externalDocs: - url: '' - GetDailyUsageUnitsResponse: - type: object - properties: - units: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DetailedDailyUnits' - description: The units. - description: Response containing daily units usage data. - externalDocs: - url: '' - GetDashboardBySlugRequest: - title: Get dashboard by URL slug request data structure - required: - - slug - type: object - properties: - slug: - maxLength: 255 - minLength: 1 - pattern: ^[a-z0-9]+(?:[-_]+[a-z0-9]+)*$ - type: string - description: The URL slug identifying the dashboard to retrieve. - description: This is a request to get a specific custom dashboard by its URL slug - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ GetDashboardBySlugResponse: title: Get dashboard by URL slug response data structure type: object @@ -37949,9 +31480,6 @@ components: description: Find out more about Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - GetDashboardCatalogRequest: - type: object - additionalProperties: false GetDashboardCatalogResponse: title: Get dashboard catalog response data structure. type: object @@ -37966,29 +31494,6 @@ components: description: Response containing the dashboard catalog. externalDocs: url: '' - GetDashboardFolderRequest: - title: Get dashboard folder request data structure - type: object - properties: - folderId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The folder id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Optional client-supplied request identifier used to correlate the - get folder request. - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ GetDashboardFolderResponse: title: Get dashboard folder response data structure type: object @@ -38002,23 +31507,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - GetDashboardRequest: - title: Get dashboard request data structure - required: - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - description: This is a request to get a specific custom dashboard - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ GetDashboardResponse: title: Get dashboard response data structure type: object @@ -38102,9 +31590,6 @@ components: description: Find out more about Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - GetDataUsageCapabilitiesRequest: - type: object - additionalProperties: false GetDataUsageCapabilitiesResponse: type: object properties: @@ -38153,127 +31638,30 @@ components: description: Capabilities of the public data-usage query surface in v1. externalDocs: url: '' - GetDataUsageMetricsExportStatusRequest: - type: object - additionalProperties: false - GetDataUsageMetricsExportStatusResponse: - title: Get Data Usage Metrics Export Status Response + GetDefaultPresetSummaryResponse: type: object properties: - enabled: - type: boolean - description: Whether this resource is enabled. - example: true - description: This data structure is used to return data usage metrics export status. + presetSummary: + $ref: '#/components/schemas/PresetSummary' + description: Response containing a summary of the default notification preset. externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetDataUsageRequest: - title: Get Data Usage Request + url: '' + GetDeployedExtensionsResponse: + title: Get deployed extensions response type: object properties: - aggregate: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AggregateBy' - description: >- - List of fields to aggregate results by (for example pillar and - priority). - dateRange: - allOf: - - $ref: '#/components/schemas/v2.DateRange' - description: Date interval to query data usage over. - dimensionFilters: + deployedExtensions: + maxItems: 10000 minItems: 0 type: array items: - $ref: '#/components/schemas/Dimension' - description: >- - Dimensions to filter results by; only entries that contain all - listed dimensions are returned. - resolution: - minLength: 0 - type: string - description: >- - Aggregation resolution. Minimum supported value is 1h. Must be - between 1 hour and the date_range interval. - description: This data structure is used to request data usage. + $ref: '#/components/schemas/DeployedExtension' + description: The deployed extensions. + description: Response containing a list of deployed extensions. externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetDataUsageResponse: - title: Get Data Usage Response - type: object - properties: - entries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataUsageEntry' - description: List of entries. - description: This data structure is used to return data usage. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetDefaultPresetSummaryRequest: - type: object - properties: - connectorType: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: The connector type whose default preset summary is requested. - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: The entity type whose default preset summary is requested. - example: ALERTS - GetDefaultPresetSummaryResponse: - type: object - properties: - presetSummary: - $ref: '#/components/schemas/PresetSummary' - description: Response containing a summary of the default notification preset. - externalDocs: - url: '' - GetDeployedExtensionsRequest: - title: Get deployed extensions request - type: object - additionalProperties: false - externalDocs: - url: '' - GetDeployedExtensionsResponse: - title: Get deployed extensions response - type: object - properties: - deployedExtensions: - maxItems: 10000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DeployedExtension' - description: The deployed extensions. - description: Response containing a list of deployed extensions. - externalDocs: - url: '' - GetDeployedIntegrationRequest: - title: Get deployed integration request - type: object - properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The integration id. - example: aws-sqs - externalDocs: - url: '' - GetDeployedIntegrationResponse: - title: Get deployed integration response + url: '' + GetDeployedIntegrationResponse: + title: Get deployed integration response type: object properties: integration: @@ -38281,27 +31669,6 @@ components: description: Response containing details of a deployed integration. externalDocs: url: '' - GetE2MRequest: - title: Get E2M Response - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier. - example: d6a3658e-78d2-47d0-9b81-b2c551f01b09 - description: >- - This data structure is used to retrieve an existing event to metric - definition - externalDocs: - description: Find out more about events2metrics - url: >- - https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ GetE2MResponse: title: Get E2M Response required: @@ -38319,9 +31686,6 @@ components: description: Find out more about events2metrics url: >- https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ - GetEnrichmentLimitRequest: - type: object - additionalProperties: false GetEnrichmentLimitResponse: title: Enrichment Limit required: @@ -38350,9 +31714,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - GetEnrichmentsRequest: - type: object - additionalProperties: false GetEnrichmentsResponse: title: Enrichment Collection required: @@ -38371,19 +31732,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - GetEventsStatisticsRequest: - title: GetEventsStatisticsRequest - required: - - filter - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/EventsFilter' - description: Filter criteria for events. - description: This data structure represents a request to get events statistics - externalDocs: - url: '' GetEventsStatisticsResponse: title: GetEventsStatisticsResponse type: object @@ -38401,47 +31749,6 @@ components: description: This data structure represents a response to get events statistics externalDocs: url: '' - GetExtensionRequest: - title: Get extension request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - includeDashboardBinaries: - type: boolean - description: Whether to include dashboard binaries in the response. - includeTestingRevision: - type: boolean - description: Whether to include testing revisions in the response. - externalDocs: - url: '' - GetExtensionResponse: - title: Get extension response - type: object - properties: - extension: - $ref: '#/components/schemas/v1.Extension' - externalDocs: - url: '' - GetGlobalRouterRequest: - title: Get Global Router Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the global router to retrieve. - description: Request to retrieve a global router with the passed identifier - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ GetGlobalRouterResponse: title: Get Global Router Response type: object @@ -38453,31 +31760,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GetGroupUsersRequest: - title: GetGroupUsersRequest - type: object - properties: - groupId: - minimum: 0 - type: integer - description: The unique identifier of the team group whose users to list. - format: int64 - pageSize: - minimum: 0 - type: integer - description: Pagination size. Defaults to 100 if empty. - format: int64 - pageToken: - minLength: 0 - type: string - description: Optional pagination continuation token. - description: >- - Request to retrieve all users assigned to a specific team group - identified by its unique ID. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ GetGroupUsersResponse: title: GetGroupUsersResponse type: object @@ -38504,13 +31786,6 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - GetGroupingKeysRequest: - title: Get grouping keys request - type: object - additionalProperties: false - description: Request to retrieve available grouping keys (empty request) - externalDocs: - url: '' GetGroupingKeysResponse: title: Get grouping keys response required: @@ -38537,21 +31812,6 @@ components: description: Response containing available grouping keys externalDocs: url: '' - GetIncidentByEventIdRequest: - title: Get incident by event id request - required: - - eventId - type: object - properties: - eventId: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Event ID associated to the Incident to acknowledge - example: event_id_1 - externalDocs: - url: '' GetIncidentByEventIdResponse: title: Get incident by event id response required: @@ -38565,23 +31825,6 @@ components: description: Response containing the requested incident externalDocs: url: '' - GetIncidentEventsRequest: - title: Get incident events request - required: - - incidentId - type: object - properties: - incidentId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: ID of the incident to retrieve events for - example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - description: Request to get all events associated with a specific incident - externalDocs: - url: '' GetIncidentEventsResponse: title: Get incident events response type: object @@ -38596,22 +31839,6 @@ components: description: Response containing all events associated with the requested incident externalDocs: url: '' - GetIncidentRequest: - title: Get incident request - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier. - example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - externalDocs: - url: '' GetIncidentResponse: title: Get incident response required: @@ -38625,58 +31852,6 @@ components: description: Response containing the requested incident externalDocs: url: '' - GetIncidentUsingCorrelationKeyRequest: - title: Get incident using correlation key request - required: - - correlationKey - - incidentPointInTime - type: object - properties: - correlationKey: - maxLength: 36 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Correlation key to identify the incident - example: correlation_key_123 - incidentPointInTime: - maxLength: 30 - minLength: 20 - type: string - description: Timestamp to identify the specific point in time for the incident - format: date-time - example: '2024-01-01T00:00:00.000Z' - description: Request to get an incident using a correlation key and timestamp - externalDocs: - url: '' - GetIncidentUsingCorrelationKeyResponse: - title: Get incident by correlation response - type: object - properties: - incident: - $ref: '#/components/schemas/Incident' - description: >- - Response containing the incident matching the correlation key and - timestamp - externalDocs: - url: '' - GetIntegrationDefinitionRequest: - title: Get integration definition request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the integration definition. - example: aws-sqs - includeTestingRevision: - type: boolean - description: Whether to include testing revisions in the response. - description: This data structure represents a list of outgoing webhook types. - externalDocs: - url: '' GetIntegrationDefinitionResponse: title: Get integration definition response type: object @@ -38686,21 +31861,6 @@ components: description: This data structure represents a list of outgoing webhook types. externalDocs: url: '' - GetIntegrationDetailsRequest: - title: Get integration details request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the integration. - includeTestingRevision: - type: boolean - description: Whether to include testing revisions in the response. - externalDocs: - url: '' GetIntegrationDetailsResponse: title: Get integration details response type: object @@ -38710,15 +31870,6 @@ components: description: Response containing the details of an integration definition. externalDocs: url: '' - GetIntegrationsRequest: - title: Get integrations request - type: object - properties: - includeTestingRevision: - type: boolean - description: Whether to include testing revisions in the response. - externalDocs: - url: '' GetIntegrationsResponse: title: Get integrations response type: object @@ -38765,206 +31916,6 @@ components: description: The upgrade available. externalDocs: url: '' - GetLabelKeysRequest: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - GetLabelKeysResponse: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - labelKeys: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetLabelMappingsInternalRequest: - type: object - properties: - dataSourceTypes: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetLabelMappingsInternalResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - GetLabelMappingsRequest: - type: object - properties: - dataSourceTypes: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetLabelMappingsResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - GetLabelNamesDay: - type: object - properties: - date: - $ref: '#/components/schemas/Date' - labelNamesStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelNamesStats' - matchedCount: - minimum: 0 - type: integer - format: int64 - GetLabelNamesRequest: - type: object - properties: - endDate: - $ref: '#/components/schemas/Date' - labelNameFilter: - $ref: '#/components/schemas/metric_schema.Filter' - length: - minimum: 0 - type: integer - format: int64 - metricName: - minLength: 0 - type: string - startDate: - $ref: '#/components/schemas/Date' - startOffset: - minimum: 0 - type: integer - format: int64 - GetLabelNamesResponse: - type: object - properties: - labelNamesDay: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/GetLabelNamesDay' - GetLabelValuesInternalRequest: - type: object - properties: - currentLabelValues: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelValues' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - endTimeSeconds: - minLength: 0 - type: string - requestedLabels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - startTimeSeconds: - minLength: 0 - type: string - GetLabelValuesInternalResponse: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - labelValues: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelValues' - GetLabelValuesRequest: - type: object - properties: - currentLabelValues: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelValues' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - endTimeSeconds: - minLength: 0 - type: string - requestedLabels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - startTimeSeconds: - minLength: 0 - type: string - GetLabelValuesResponse: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - labelValues: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelValues' - GetLabelsRequest: - type: object - additionalProperties: false - GetLabelsResponse: - type: object - properties: - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetLimitsRequest: - type: object - additionalProperties: false GetLimitsResponse: type: object properties: @@ -38988,764 +31939,116 @@ components: description: Response containing the events-to-metrics quota limits. externalDocs: url: '' - GetLiveErrorLogsRequest: + GetManagedIntegrationStatusResponse: + title: Get managed integration status response type: object properties: - endTimeEpochMs: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - length: - minimum: 0 - type: integer - format: int64 - pattern: + integrationId: + maxLength: 65535 minLength: 0 + pattern: ^[\s\S]*$ type: string - sources: - minItems: 0 - type: array - items: - minLength: 0 - type: string - startOffset: - minimum: 0 - type: integer - format: int64 - startTimeEpochMs: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - GetLiveErrorLogsResponse: + description: The integration id. + status: + $ref: '#/components/schemas/IntegrationStatus' + description: Response containing the status of a managed integration. + externalDocs: + url: '' + GetOutgoingWebhookResponse: + title: Get outgoing webhook response type: object properties: - errorLogs: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LiveErrorLogEntry' - sourceStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LiveErrorLogSourceStat' - GetLogsCountRequest: - title: Get Logs Count Request + webhook: + $ref: '#/components/schemas/OutgoingWebhook' + description: Response containing the details of an outgoing webhook. + externalDocs: + url: '' + GetOutgoingWebhookTypeDetailsResponse: + title: Get outgoing webhook type details response type: object properties: - applicationAggregation: - type: boolean - description: When true, aggregate the returned counts by application name. - dateRange: - allOf: - - $ref: '#/components/schemas/v2.DateRange' - description: Date interval to query log ingestion counts over. - filters: - allOf: - - $ref: '#/components/schemas/ScopesFilter' - description: >- - Optional scope filter that restricts results to the listed - applications and subsystems (full match). - resolution: - minLength: 0 - type: string - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - subsystemAggregation: - type: boolean - description: When true, aggregate the returned counts by subsystem name. - description: This data structure is used to request logs count. + details: + $ref: '#/components/schemas/OutgoingWebhookDetails' + description: Response containing the details of an outgoing webhook type. externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetLogsCountResponse: - title: Get Logs Count Response + url: '' + GetPolicyResponse: + title: Get Policy Response type: object properties: - logsCount: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LogsCount' - description: The logs count. - description: This data structure is used to return logs count. + policy: + $ref: '#/components/schemas/Policy' + description: This data structue is obtained when retrieving a policy by its ID. externalDocs: - description: Find out more about data usage. + description: Find out more about quota management. url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetManagedIntegrationStatusRequest: - title: Get managed integration status request + https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ + GetPolicySettingsResponse: + title: Get Policy Priority Settings Response type: object properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the managed integration. + logsPolicySettings: + $ref: '#/components/schemas/LogsPolicySettings' + spansPolicySettings: + $ref: '#/components/schemas/SpansPolicySettings' + description: This data structure is returned when getting policy priority settings. externalDocs: url: '' - GetManagedIntegrationStatusResponse: - title: Get managed integration status response + GetPresetResponse: type: object properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The integration id. - status: - $ref: '#/components/schemas/IntegrationStatus' - description: Response containing the status of a managed integration. + preset: + $ref: '#/components/schemas/Preset' + description: Response containing the details of a notification preset. externalDocs: url: '' - GetMeasurementsInternalRequest: + GetQuotaAllocationRuleSetResponse: + title: Get quota allocation rule set response type: object properties: - dataSourceTypes: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - measurementNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetMeasurementsInternalResponse: + ruleSet: + $ref: '#/components/schemas/QuotaAllocationEntityTypeRuleSet' + description: Response containing quota allocation rule set + externalDocs: + url: '' + GetRetentionsEnabledResponse: + title: Get Retentions Enabled Response type: object properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - GetMeasurementsRequest: + enableTags: + type: boolean + description: The enable tags. + description: >- + This data structure is obtained when retrieving the active status of + retentions + externalDocs: + description: Find out more about archives + url: >- + https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ + GetRetentionsResponse: type: object properties: - dataSourceTypes: + retentions: minItems: 0 type: array items: - $ref: '#/components/schemas/DataSourceType' - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - measurementNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - GetMeasurementsResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - GetMeasurementsTableRequest: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - endTimeSeconds: - minLength: 0 - type: string - labelValues: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelValues' - measurementMetadata: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MeasurementMetadata' - measurementNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - orderingLabel: - minLength: 0 - type: string - paginationData: - $ref: '#/components/schemas/PaginationData' - rowLabelValues: - allOf: - - $ref: '#/components/schemas/LabelValues' - deprecated: true - startTimeSeconds: - minLength: 0 - type: string - subjectLabel: - minLength: 0 - type: string - topk: - type: integer - format: int32 - GetMeasurementsTableResponse: - type: object - properties: - existingColumns: - minItems: 0 - type: array - items: - minLength: 0 - type: string - pageIndex: - type: integer - format: int32 - pageSize: - type: integer - description: Page size. - format: int32 - rows: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TableRow' - totalRowCount: - type: integer - format: int32 - GetMetricEntityUsagesRequest: - title: Get Metric Entity Usages Request - required: - - entityType - - startDate - - endDate - - length - type: object - properties: - endDate: - allOf: - - $ref: '#/components/schemas/Date' - description: >- - End of the date range (inclusive), in UTC. The inclusive range must - span at most 7 calendar days. - entityType: - allOf: - - $ref: '#/components/schemas/metric_usage_service.EntityType' - description: >- - Whether to query metric-level or service-level usage. For - ENTITY_METRIC, records and daily totals include `metric` extras; for - ENTITY_SERVICE, `service` extras. Other entity types may omit - entity-specific extras. - filters: - maxItems: 6 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UsageFilter' - description: >- - Filters applied to usage records (AND-combined). Each item must set - exactly one filter variant. - groupBy: - maxItems: 4 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/PillarType' - description: >- - Pillars to aggregate by. Order is irrelevant; duplicate entries are - rejected. - length: - maximum: 1000 - minimum: 1 - type: integer - description: Maximum number of records per day (1-1000). - format: int64 - orderBy: - allOf: - - $ref: '#/components/schemas/metric_usage_service.OrderBy' - description: Field to sort records by. - ordering: - allOf: - - $ref: '#/components/schemas/metric_usage_service.Ordering' - description: Sort direction. - skipTotals: - type: boolean - description: >- - When true, daily totals will be omitted and fraction fields will be - set to zero. - startDate: - allOf: - - $ref: '#/components/schemas/Date' - description: Start of the date range (inclusive), in UTC. - startOffset: - maximum: 10000000 - minimum: 0 - type: integer - description: Pagination offset within each day. - format: int64 - description: Request for pillar-based aggregated metric usage. - externalDocs: - url: '' - GetMetricEntityUsagesResponse: - title: Get Metric Entity Usages Response - required: - - dailyUsages - type: object - properties: - dailyUsages: - maxItems: 7 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/UsageDay' - description: One entry per day in the requested range. - description: Daily aggregated metric usage results. - externalDocs: - url: '' - GetMetricNamesDay: - type: object - properties: - date: - $ref: '#/components/schemas/Date' - matchedCount: - minimum: 0 - type: integer - format: int64 - metricNameStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MetricNameStats' - GetMetricNamesRequest: - type: object - properties: - endDate: - $ref: '#/components/schemas/Date' - length: - minimum: 0 - type: integer - format: int64 - metricNameFilter: - $ref: '#/components/schemas/metric_schema.Filter' - startDate: - $ref: '#/components/schemas/Date' - startOffset: - minimum: 0 - type: integer - format: int64 - GetMetricNamesResponse: - type: object - properties: - metricNamesDay: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/GetMetricNamesDay' - GetOllyAnalysisSettingsRequest: - type: object - properties: - id: - minLength: 0 - type: string - GetOllyAnalysisSettingsResponse: - type: object - properties: - ollyAnalysisSettings: - $ref: '#/components/schemas/OllyAnalysisSettings' - GetOutgoingWebhookRequest: - title: Get outgoing webhook request - type: object - properties: - id: - minLength: 0 - type: string - description: The unique identifier of the outgoing webhook. - externalDocs: - url: '' - GetOutgoingWebhookResponse: - title: Get outgoing webhook response - type: object - properties: - webhook: - $ref: '#/components/schemas/OutgoingWebhook' - description: Response containing the details of an outgoing webhook. - externalDocs: - url: '' - GetOutgoingWebhookTypeDetailsRequest: - title: Get outgoing webhook type details request - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/WebhookType' - description: The outgoing webhook type to fetch details for. - externalDocs: - url: '' - GetOutgoingWebhookTypeDetailsResponse: - title: Get outgoing webhook type details response - type: object - properties: - details: - $ref: '#/components/schemas/OutgoingWebhookDetails' - description: Response containing the details of an outgoing webhook type. - externalDocs: - url: '' - GetPagerDutyServicesRequest: - type: object - properties: - integrationId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The integration id. - GetPagerDutyServicesResponse: - type: object - properties: - services: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/PagerDutyService' - description: The PagerDuty services. - GetPolicyRequest: - title: Get Policy Request - required: - - id - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The unique identifier of the data policy to retrieve. - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - description: This data structue is used to retrieve a policy by its ID. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - GetPolicyResponse: - title: Get Policy Response - type: object - properties: - policy: - $ref: '#/components/schemas/Policy' - description: This data structue is obtained when retrieving a policy by its ID. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - GetPolicySettingsRequest: - title: Get Policy Priority Settings Request - type: object - additionalProperties: false - description: This data structure is used to get policy priority settings. - externalDocs: - url: '' - GetPolicySettingsResponse: - title: Get Policy Priority Settings Response - type: object - properties: - logsPolicySettings: - $ref: '#/components/schemas/LogsPolicySettings' - spansPolicySettings: - $ref: '#/components/schemas/SpansPolicySettings' - description: This data structure is returned when getting policy priority settings. - externalDocs: - url: '' - GetPresetRequest: - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the preset to retrieve. - GetPresetResponse: - type: object - properties: - preset: - $ref: '#/components/schemas/Preset' - description: Response containing the details of a notification preset. - externalDocs: - url: '' - GetQueriesRequest: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - endTimeSeconds: - minLength: 0 - type: string - extractedLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ExtractedLabel' - measurementMetadata: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MeasurementMetadata' - measurementNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - orderingLabel: - minLength: 0 - type: string - deprecated: true - startTimeSeconds: - minLength: 0 - type: string - subjectLabel: - minLength: 0 - type: string - topk: - type: integer - format: int32 - GetQueriesResponse: - type: object - properties: - queries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MeasurementQuery' - GetQueryUsageRequest: - type: object - properties: - endDate: - $ref: '#/components/schemas/Date' - pattern: - minLength: 0 - type: string - startDate: - $ref: '#/components/schemas/Date' - GetQueryUsageResponse: - type: object - properties: - queryUsageDays: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsageDay' - GetQueryUsagesBySourceUrisRequest: - type: object - properties: - endDate: - $ref: '#/components/schemas/Date' - length: - minimum: 0 - type: integer - format: int64 - orderBy: - $ref: '#/components/schemas/query_usages.OrderBy' - ordering: - $ref: '#/components/schemas/query_usages.Ordering' - pattern: - minLength: 0 - type: string - sourceUriFilter: - minLength: 0 - type: string - sources: - minItems: 0 - type: array - items: - minLength: 0 - type: string - startDate: - $ref: '#/components/schemas/Date' - startOffset: - minimum: 0 - type: integer - format: int64 - GetQueryUsagesBySourceUrisResponse: - type: object - properties: - queryUsagesBySourceUrisDays: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsagesBySourceUrisDay' - GetQueryUsagesRequest: - type: object - properties: - endDate: - $ref: '#/components/schemas/Date' - length: - minimum: 0 - type: integer - format: int64 - orderBy: - $ref: '#/components/schemas/query_usages.OrderBy' - ordering: - $ref: '#/components/schemas/query_usages.Ordering' - patternFilter: - minLength: 0 - type: string - sources: - minItems: 0 - type: array - items: - minLength: 0 - type: string - startDate: - $ref: '#/components/schemas/Date' - startOffset: - minimum: 0 - type: integer - format: int64 - GetQueryUsagesResponse: - type: object - properties: - queryUsagesDays: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsagesDay' - GetQuotaAllocationRuleSetRequest: - title: Get quota allocation rule set request - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. - description: Request to retrieve quota allocation rule set - externalDocs: - url: '' - GetQuotaAllocationRuleSetResponse: - title: Get quota allocation rule set response - type: object - properties: - ruleSet: - $ref: '#/components/schemas/QuotaAllocationEntityTypeRuleSet' - description: Response containing quota allocation rule set - externalDocs: - url: '' - GetRetentionsEnabledRequest: - type: object - additionalProperties: false - GetRetentionsEnabledResponse: - title: Get Retentions Enabled Response - type: object - properties: - enableTags: - type: boolean - description: The enable tags. - description: >- - This data structure is obtained when retrieving the active status of - retentions - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - GetRetentionsRequest: - type: object - additionalProperties: false - GetRetentionsResponse: - type: object - properties: - retentions: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/archive.v1.Retention' - description: The retentions. - description: Response containing the current data retention settings. - externalDocs: - url: '' - GetRuleGroupModelMappingRequest: - type: object - properties: - creator: - minLength: 0 - type: string - description: Creator. - description: - minLength: 0 - type: string - description: Human-readable description. - enabled: - type: boolean - description: Whether this resource is enabled. - hidden: - type: boolean - description: Whether to hide this rule group from the standard view. - name: - minLength: 0 - type: string - description: Display name. - order: - minimum: 0 - type: integer - description: Sort order. - format: int64 - ruleMatchers: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RuleMatcher' - description: >- - List of rule matchers that determine which logs this group applies - to. - ruleSubgroups: - minItems: 0 - type: array - items: - $ref: >- - #/components/schemas/GetRuleGroupModelMappingRequest.CreateRuleSubgroup - description: >- - List of rule subgroups defining the ordered set of rules in this - group. - description: Request for retrieving the model mapping for a parsing rule group. - externalDocs: - url: '' - GetRuleGroupModelMappingRequest.CreateRuleSubgroup: - type: object - properties: - enabled: - type: boolean - description: Whether this resource is enabled. - order: - minimum: 0 - type: integer - description: Sort order. - format: int64 - rules: + $ref: '#/components/schemas/archive.v1.Retention' + description: The retentions. + description: Response containing the current data retention settings. + externalDocs: + url: '' + GetRuleGroupModelMappingRequest.CreateRuleSubgroup: + type: object + properties: + enabled: + type: boolean + description: Whether this resource is enabled. + order: + minimum: 0 + type: integer + description: Sort order. + format: int64 + rules: minItems: 0 type: array items: @@ -39786,13 +32089,6 @@ components: description: Response containing the model mapping for a parsing rule group. externalDocs: url: '' - GetRuleGroupRequest: - type: object - properties: - groupId: - minLength: 0 - type: string - description: The unique identifier of the parsing rule group to retrieve. GetRuleGroupResponse: type: object properties: @@ -39801,18 +32097,6 @@ components: description: Response containing the details of a parsing rule group. externalDocs: url: '' - GetRumApplicationVersionDataRequest: - title: Get RUM application version data request - type: object - properties: - applicationName: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The name of the RUM application to fetch version data for. - externalDocs: - url: '' GetRumApplicationVersionDataResponse: title: Get RUM application version data response type: object @@ -39822,23 +32106,6 @@ components: description: Response containing RUM application version data. externalDocs: url: '' - GetSPParametersRequest: - title: Get SP Parameters Request - type: object - properties: - teamId: - minimum: 0 - type: integer - description: Team identifier. - format: int64 - example: 1234567 - description: >- - This data structure is used to retrieve the parameters of a SAML service - provider - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ GetSPParametersResponse: title: Get SP Parameters Response type: object @@ -39869,9 +32136,6 @@ components: description: Find out more about scopes url: >- https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - GetSendDataApiKeysRequest: - type: object - additionalProperties: false GetSendDataApiKeysResponse: title: Get Api Key Response type: object @@ -39887,49 +32151,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - GetSlackChannelInfoRequest: - type: object - properties: - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The connector id. - example: connector-id-1 - GetSlackChannelInfoResponse: - type: object - properties: - channelId: - maxLength: 100 - minLength: 1 - pattern: ^[A-Za-z0-9]+$ - type: string - description: The channel id. - example: C1234567890 - channelName: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The channel name. - example: notifications - isPrivate: - type: boolean - description: Is the channel private. - GetSloRequest: - title: GetSloRequest - required: - - id - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. - description: Request to retrieve a specific SLO by its ID. - externalDocs: - url: '' GetSloResponse: title: GetSloResponse required: @@ -39941,52 +32162,6 @@ components: description: Response containing the details of a specific SLO. externalDocs: url: '' - GetSpansCountRequest: - title: Get Spans Count Request - type: object - properties: - dateRange: - allOf: - - $ref: '#/components/schemas/v2.DateRange' - description: Date interval to query span ingestion counts over. - filters: - allOf: - - $ref: '#/components/schemas/ScopesFilter' - description: >- - Optional scope filter that restricts results to the listed - applications and subsystems (full match). - resolution: - minLength: 0 - type: string - description: >- - Aggregation resolution with second precision. Must be between 1 - second and the date_range interval. - description: This data structure is used to request spans count. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetSpansCountResponse: - title: Get Spans Count Response - type: object - properties: - spansCount: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SpansCount' - description: The spans count. - description: This data structure is used to return spans count. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetSystemDefaultCaseSettingsRequest: - title: Get default case settings request - type: object - additionalProperties: false - externalDocs: - url: '' GetSystemDefaultCaseSettingsResponse: title: Get default case settings response required: @@ -40008,44 +32183,6 @@ components: configuration values. externalDocs: url: '' - GetSystemDefaultOllyAnalysisSettingsRequest: - type: object - additionalProperties: false - GetSystemDefaultOllyAnalysisSettingsResponse: - type: object - properties: - enabled: - type: boolean - monthlyCapacity: - type: integer - format: int32 - ownershipLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FilterGroup' - priorityFilter: - $ref: '#/components/schemas/CasePriorityFilter' - GetSystemDefaultPresetSummaryRequest: - title: Get System Default Preset Summary Request - type: object - properties: - connectorType: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: The connector type whose system default preset summary is requested. - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: The entity type whose system default preset summary is requested. - example: ALERTS - description: >- - Returns the preset summary for the system default preset (i.e., not a - user-selected default) - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ GetSystemDefaultPresetSummaryResponse: type: object properties: @@ -40054,85 +32191,6 @@ components: description: Response containing a summary of the system default notification preset. externalDocs: url: '' - GetTargetRequest: - type: object - additionalProperties: false - GetTargetResponse: - title: Get Target Response - required: - - target - type: object - properties: - target: - $ref: '#/components/schemas/v2.Target' - description: This data structure is used to retrieve a storage target for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - GetTeamDetailedDataUsageRequest: - title: Get Team Detailed Data Usage Request - type: object - properties: - aggregate: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AggregateBy' - dateRange: - $ref: '#/components/schemas/v2.DateRange' - resolution: - minLength: 0 - type: string - description: This data structure is used to request detailed data usage for a team. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - GetTeamDetailedDataUsageResponse: - title: Get Team Detailed Data Usage Response - type: object - properties: - dimensions: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Dimension' - description: The dimensions. - sizeGb: - type: number - description: The size gb. - format: float - example: 2.5 - timestamp: - minLength: 0 - type: string - description: Timestamp of the event. - format: date-time - example: '2021-01-01T00:00:00.000Z' - units: - type: number - description: The units. - format: float - example: 5 - description: This data structure is used to return detailed data usage for a team. - externalDocs: - url: '' - GetTeamGroupByNameRequest: - title: GetTeamGroupByNameRequest - type: object - properties: - name: - minLength: 0 - type: string - description: The name of the team group to retrieve. - description: >- - Request to retrieve a team group using its name within the authenticated - team's context. Alternative to lookup by ID. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ GetTeamGroupByNameResponse: title: GetTeamGroupByNameResponse type: object @@ -40146,22 +32204,6 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - GetTeamGroupRequest: - title: GetTeamGroupRequest - type: object - properties: - groupId: - minimum: 0 - type: integer - description: The unique identifier of the team group. - format: int64 - description: >- - Request to retrieve a specific team group by its unique identifier. Used - to fetch details about group membership, roles, and scope settings. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ GetTeamGroupResponse: title: GetTeamGroupResponse type: object @@ -40175,33 +32217,6 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - GetTeamGroupsRequest: - title: GetTeamGroupsRequest - type: object - properties: - pageSize: - minimum: 0 - type: integer - description: Page size. - format: int64 - pageToken: - minLength: 0 - type: string - description: The page token. - teamId: - minimum: 0 - type: integer - description: >- - Team to fetch team groups for. If not set, fetches groups associated - with the logged in team. - format: int64 - description: >- - Request to retrieve all groups associated with a specific team. If - team_id is not provided, fetches groups for the authenticated team. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ GetTeamGroupsResponse: title: GetTeamGroupsResponse type: object @@ -40226,15 +32241,6 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - GetTeamMembersApiKeysRequest: - title: Get Team Members API Keys Request - type: object - additionalProperties: false - description: This data structure is used to retrieve all API keys for team members. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ GetTeamMembersApiKeysResponse: title: Get Team Members API Keys Response type: object @@ -40252,46 +32258,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - GetTeamQuotaRequest: - type: object - properties: - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team whose quota is retrieved. - description: Request to retrieve the quota settings of a team. - externalDocs: - url: '' - GetTeamQuotaResponse: - type: object - properties: - quota: - type: number - description: Daily quota assigned to the team, in quota units per day. - format: float - retention: - maximum: 2147483647 - minimum: 0 - type: integer - description: Retention period of the team's data, in days. - format: int32 - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team. - description: Response containing the quota settings of a team. - externalDocs: - url: '' - GetTeamRequest: - type: object - properties: - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team to retrieve. - description: Request to retrieve a single team. - externalDocs: - url: '' GetTeamResponse: type: object properties: @@ -40318,69 +32284,6 @@ components: description: Response containing the requested team. externalDocs: url: '' - GetTeamScopesByIdsRequest: - title: Get Team Scopes By Ids Request - required: - - ids - type: object - properties: - ids: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of team scope identifiers to retrieve. - example: 60c82be2-413f-4b8e-8201-7f5c51e2ef2b - description: List of team scope identifiers to retrieve. - description: This data structure represents a request to get team scopes by ids - externalDocs: - description: Find out more about scopes - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - GetTeamScopesRequest: - type: object - additionalProperties: false - GetTemplateRequest: - title: Get template request - type: object - oneOf: - - required: - - commonArmParams - type: object - - required: - - empty - type: object - - type: object - not: - anyOf: - - required: - - commonArmParams - type: object - - required: - - empty - type: object - properties: - commonArmParams: - allOf: - - $ref: '#/components/schemas/CommonARMParams' - description: >- - Common ARM integration parameters (logs URL, API key, cgx domain) - supplied when rendering the template. - empty: - allOf: - - $ref: '#/components/schemas/Empty' - description: >- - Empty extra parameters; use when the template does not require - additional inputs. - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the integration to fetch a template for. - externalDocs: - url: '' GetTemplateResponse: title: Get template response type: object @@ -40394,18 +32297,6 @@ components: description: Response containing an integration template. externalDocs: url: '' - GetTenantConfigRequest: - type: object - properties: - tenantId: - minimum: 0 - type: integer - format: int64 - GetTenantConfigResponse: - type: object - properties: - tenantConfig: - $ref: '#/components/schemas/TenantConfig' GetTenantConfigResponseV2: type: object properties: @@ -40414,28 +32305,6 @@ components: description: Response containing the current metrics tenant configuration. externalDocs: url: '' - GetUserRequest: - title: GetUserRequest - type: object - properties: - teamId: - minimum: 0 - type: integer - description: Team ID to search within - format: int64 - userAccountId: - minimum: 0 - type: integer - description: User account ID to retrieve - format: int64 - description: >- - Request to retrieve a specific user by their user account ID within a - team. Returns complete user details including name, status, login modes, - and access type. - externalDocs: - description: Find out more about user management - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ GetUserResponse: title: GetUserResponse type: object @@ -40452,47 +32321,6 @@ components: description: Find out more about user management url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - GetViewFolderRequest: - title: GetViewFolderRequest - type: object - properties: - id: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: Unique identifier for folders - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - description: Request for getting view folder. - externalDocs: - url: '' - GetViewFolderResponse: - type: object - properties: - folder: - $ref: '#/components/schemas/ViewFolder' - GetViewRequest: - type: object - properties: - id: - maximum: 2147483647 - minimum: 1 - type: integer - description: id - format: int32 - example: 52 - GetViewResponse: - type: object - properties: - view: - $ref: '#/components/schemas/View' - GetZeroStateRequest: - title: GetZeroStateRequest - type: object - additionalProperties: false - description: Request to get zero state (boolean). - externalDocs: - url: '' GetZeroStateResponse: title: GetZeroStateResponse required: @@ -40607,15 +32435,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - GlobalRouter.EntityLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string GoToDashboardTemplateAction: type: object properties: @@ -40628,35 +32447,6 @@ components: description: Go to dashboard template action. externalDocs: url: '' - GroupBy: - title: Incident group by - type: object - oneOf: - - required: - - incidentField - type: object - - required: - - contextualLabel - type: object - properties: - contextualLabel: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The contextual label to group by. - incidentField: - allOf: - - $ref: '#/components/schemas/IncidentFields' - description: The field to group by - example: INCIDENTS_FIELDS_ID - orderByDirection: - allOf: - - $ref: '#/components/schemas/v1.OrderByDirection' - description: The order by direction. - example: ORDER_BY_DIRECTION_ASC - externalDocs: - url: '' GroupByValues: type: object oneOf: @@ -40682,21 +32472,6 @@ components: description: The contextual labels. incidentField: $ref: '#/components/schemas/IncidentFieldOneOf' - GroupLimit: - type: object - properties: - groupByFields: - minItems: 0 - type: array - items: - minLength: 0 - type: string - limit: - type: integer - format: int32 - minPercentage: - type: integer - format: int32 GroupOrigin: enum: - GROUP_ORIGIN_UNSPECIFIED @@ -40712,42 +32487,6 @@ components: - GROUP_TYPE_RESTRICTED type: string description: Group type. - GroupValue: - type: object - properties: - labels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/v1.LabelValue' - GroupedExecutionStats: - type: object - properties: - source: - minLength: 0 - type: string - stats: - $ref: '#/components/schemas/ExecStats' - status: - $ref: '#/components/schemas/ExecStatus' - type: - $ref: '#/components/schemas/query_usages.QueryType' - GroupedSeries: - type: object - properties: - groups: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/common.Group' - GroupsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/v3.Group' HallucinationCompletenessConfig: type: object additionalProperties: false @@ -40782,31 +32521,6 @@ components: description: Configuration for the HallucinationTaskAdherence evaluation (no fields). externalDocs: url: '' - Header: - type: object - properties: - bucketCount: - minimum: 0 - type: integer - format: int64 - bucketDuration: - minLength: 0 - type: string - maxUsageEntriesPerMessage: - minimum: 0 - type: integer - format: int64 - queryRange: - $ref: '#/components/schemas/UsageTimestampRange' - HeadersEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string Heatmap: type: object oneOf: @@ -41958,16 +33672,6 @@ components: - Y_AXIS_VIEW_BY_VALUE type: string description: Y axis view by - group category or value. - HotStoreConfig: - type: object - properties: - clusterName: - minLength: 0 - type: string - tenantId: - minimum: 0 - type: integer - format: int64 IBMCosTargetSpec: title: IBM COS Target Spec required: @@ -42082,23 +33786,6 @@ components: - IBM_BUCKET_TYPE_INTERNAL type: string description: Ibm bucket type. - IbmConfig: - type: object - properties: - bucket: - minLength: 0 - type: string - description: Bucket name. - crn: - minLength: 0 - type: string - endpoint: - minLength: 0 - type: string - region: - minLength: 0 - type: string - description: Region. IbmConfigV2: title: IBM Bucket Configuration type: object @@ -42256,15 +33943,6 @@ components: description: Find out more about recording rules url: >- https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ - InRule.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string InRuleGroup: title: In Rule Group required: @@ -42434,24 +34112,6 @@ components: description: Incident. externalDocs: url: '' - Incident.ContextualLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - Incident.DisplayLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string IncidentAggregation: title: Incident aggregation required: @@ -42780,70 +34440,6 @@ components: description: Incident event originator operational. externalDocs: url: '' - IncidentEventQueryFilter: - title: Incident event query filter - type: object - properties: - contextualLabels: - type: object - additionalProperties: - $ref: '#/components/schemas/ContextualLabelValues' - description: The contextual labels of the incident - displayLabels: - type: object - additionalProperties: - $ref: '#/components/schemas/DisplayLabelValues' - description: The display labels of the incident - isMuted: - type: boolean - description: Indicates if the incident is muted - labels: - allOf: - - $ref: '#/components/schemas/LabelsFilter' - description: The labels of the incident - name: - maxLength: 500 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The name of the incident - severity: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/IncidentSeverity' - description: The severity of the incident - status: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/IncidentStatus' - description: The status of the incident - timestamp: - allOf: - - $ref: '#/components/schemas/v1.TimeRange' - description: The time range of the incident - description: Filter configuration for incident events - externalDocs: - url: '' - IncidentEventQueryFilter.ContextualLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ContextualLabelValues' - IncidentEventQueryFilter.DisplayLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/DisplayLabelValues' IncidentEventSnoozeIndicator: title: Incident event snooze indicator type: object @@ -43090,15 +34686,6 @@ components: $ref: '#/components/schemas/incidents.v1.MetaLabel' externalDocs: url: '' - IncidentPermutationEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string IncidentQueryFilter: title: Incident query filter type: object @@ -43212,22 +34799,6 @@ components: description: Filter configuration for incidents externalDocs: url: '' - IncidentQueryFilter.ContextualLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ContextualLabelValues' - IncidentQueryFilter.DisplayLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/DisplayLabelValues' IncidentQueryFiltersValues: title: Incident query filter values required: @@ -43291,22 +34862,6 @@ components: description: Incident query filters values. externalDocs: url: '' - IncidentQueryFiltersValues.ContextualLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ContextualLabelValuesWithCount' - IncidentQueryFiltersValues.DisplayLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/DisplayLabelValuesWithCount' IncidentSearchQuery: title: Incident search query required: @@ -43478,14 +35033,6 @@ components: example: incident_status externalDocs: url: '' - IncidentsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/Incident' IndicatorFilter: title: Indicator filter type: object @@ -43574,108 +35121,6 @@ components: - INDICATOR_TYPE_PROMETHEUS_ALERTMANAGER - INDICATOR_TYPE_ERROR_TRACKING type: string - InitializeConnectorRedirectReason: - enum: - - INITIALIZE_CONNECTOR_REDIRECT_REASON_UNSPECIFIED - - INITIALIZE_CONNECTOR_REDIRECT_REASON_MISSING_REQUIRED_FIELDS - - INITIALIZE_CONNECTOR_REDIRECT_REASON_SECRETS_NOT_ACCEPTED - type: string - description: The reason a connector could not be initialized or updated directly. - InitializeConnectorRequest: - title: Initialize Connector Request - type: object - properties: - connector: - $ref: '#/components/schemas/Connector' - description: >- - Request to initialize a new connector. Never accepts secret values: - creates the connector when no secret is required, otherwise returns a - pre-fill link to finish setup in the Coralogix UI. - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - InitializeConnectorResponse: - title: Initialize Connector Response - type: object - properties: - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The identifier of the created connector. Set when isCreated is true. - isCreated: - type: boolean - description: >- - True only when the connector was created without requiring any - secret. - link: - maxLength: 50000 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: >- - A pre-filled UI link to finish creating the connector. Set when - isCreated is false. - reason: - allOf: - - $ref: '#/components/schemas/InitializeConnectorRedirectReason' - description: >- - The reason the connector could not be created directly. Set when - isCreated is false. - description: >- - Response describing whether the connector was created, or a link to - finish setup in the UI - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - InitializeConnectorUpdateRequest: - title: Initialize Connector Update Request - type: object - properties: - connector: - $ref: '#/components/schemas/Connector' - description: >- - Request to update an existing connector, identified by its `id`, without - providing secret values; stored secrets are retained. Secret values are - never accepted — if one is supplied the update is not applied and a - pre-fill link to finish the update in the Coralogix UI is returned. - Omitted fields like name, description, connector config, etc are left - unchanged. - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - InitializeConnectorUpdateResponse: - title: Initialize Connector Update Response - type: object - properties: - isUpdated: - type: boolean - description: True only when the update was applied without requiring any secret. - link: - maxLength: 2000 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: >- - A pre-filled UI link to finish updating the connector. Set when - isUpdated is false. - reason: - allOf: - - $ref: '#/components/schemas/InitializeConnectorRedirectReason' - description: >- - The reason the connector could not be updated directly. Set when - isUpdated is false. - description: >- - Response describing whether the connector was updated, or a link to - finish the update in the UI - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ InputType: enum: - API_KEY @@ -43693,32 +35138,6 @@ components: - AWS_CLOUDWATCH_NAMESPACE_LIST type: string description: Input type. - InsertCompanyMeasurementsRequest: - type: object - properties: - measurementIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - InsertCompanyMeasurementsResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - Instant.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string Integration: title: Integration type: object @@ -44096,60 +35515,12 @@ components: description: This data structure represents an integration status. externalDocs: url: '' - IntegrationStatus.DetailsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string InternalSectionOptions: type: object additionalProperties: false description: Internal section options. externalDocs: url: '' - InternalUpdateRequest: - type: object - oneOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - - type: object - not: - anyOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - properties: - gcs: - $ref: '#/components/schemas/GcsConfig' - ibm: - $ref: '#/components/schemas/IbmConfigV2' - retentionDays: - minimum: 0 - type: integer - format: int64 - s3: - $ref: '#/components/schemas/S3Config' - tenantId: - minimum: 0 - type: integer - format: int64 Interpretation: enum: - INTERPRETATION_UNSPECIFIED @@ -44239,51 +35610,6 @@ components: description: Find out more about IP access control in our documentation url: >- https://coralogix.com/docs/user-guides/account-management/account-settings/ip-access-control/ - IpAccessEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/IpAccess' - IsFilterPredicate: - title: IsFilterPredicate - type: object - oneOf: - - required: - - stringValues - type: object - - required: - - typeValues - type: object - - required: - - productTypeValues - type: object - - type: object - not: - anyOf: - - required: - - stringValues - type: object - - required: - - typeValues - type: object - - required: - - productTypeValues - type: object - properties: - productTypeValues: - $ref: '#/components/schemas/ProductTypeValues' - stringValues: - $ref: '#/components/schemas/StringValues' - typeValues: - $ref: '#/components/schemas/TypeValues' - description: >- - Predicate for SLO filters that checks if a field is equal to one of - multiple values - externalDocs: - url: '' Issue: type: object properties: @@ -44402,27 +35728,6 @@ components: description: Jira config. externalDocs: url: '' - JobDefinition: - type: object - properties: - labelName: - minLength: 0 - type: string - labelValue: - minLength: 0 - type: string - metricName: - minLength: 0 - type: string - singleHourWindow: - $ref: '#/components/schemas/SingleHourWindow' - JobStatus: - enum: - - PENDING - - RUNNING - - COMPLETED - - FAILED - type: string JsonExtractParameters: type: object properties: @@ -44639,24 +35944,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - KeyValuesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - Label: - type: object - properties: - name: - minLength: 0 - type: string - value: - minLength: 0 - type: string LabelFilterType: title: Label filter type type: object @@ -44699,85 +35986,6 @@ components: description: Filters for application name, subsystem name, and log severities externalDocs: url: '' - LabelMapping: - type: object - properties: - dataSource: - $ref: '#/components/schemas/DataSource' - dataSourceType: - $ref: '#/components/schemas/DataSourceType' - description: - minLength: 0 - type: string - description: Human-readable description. - displayName: - minLength: 0 - type: string - extractionTemplate: - minLength: 0 - type: string - deprecated: true - extractionTemplates: - minItems: 0 - type: array - items: - minLength: 0 - type: string - id: - minLength: 0 - type: string - isCustomLabel: - type: boolean - label: - minLength: 0 - type: string - LabelNamesStats: - type: object - properties: - labelName: - minLength: 0 - type: string - uniqueValueCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - LabelValues: - type: object - properties: - labelName: - minLength: 0 - type: string - values: - minItems: 0 - type: array - items: - minLength: 0 - type: string - LabelledValue: - type: object - properties: - labels: - type: object - additionalProperties: - minLength: 0 - type: string - name: - minLength: 0 - type: string - description: Display name. - value: - type: number - format: double - LabelledValue.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string LabelsFilter: title: Label filter configuration required: @@ -44834,18 +36042,6 @@ components: description: Last. externalDocs: url: '' - LatencyQueryType: - enum: - - LATENCY_QUERY_TYPE_UNSPECIFIED - - LATENCY_QUERY_TYPE_QUANTILE - - LATENCY_QUERY_TYPE_AVERAGE - type: string - LatencyThresholdUnit: - enum: - - LATENCY_THRESHOLD_UNIT_UNSPECIFIED - - LATENCY_THRESHOLD_UNIT_MILLISECONDS - - LATENCY_THRESHOLD_UNIT_SECONDS - type: string Layout: type: object properties: @@ -44915,16 +36111,6 @@ components: - LEGEND_PLACEMENT_HIDDEN type: string description: Legend placement. - LessThanConditionOperator: - type: object - properties: - undetectedValuesManagement: - $ref: '#/components/schemas/v1.UndetectedValuesManagement' - LessThanOrEqualsConditionOperator: - type: object - properties: - undetectedValuesManagement: - $ref: '#/components/schemas/v1.UndetectedValuesManagement' LimitUsage: type: object properties: @@ -45364,26 +36550,6 @@ components: pattern: ^[\s\S]*$ type: string description: Static URL that may contain variables using {{variable_name}} syntax - LinkCustomEvaluationRequest: - type: object - properties: - applicationId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI application to link to. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the custom evaluation. - description: Request to link a custom evaluation to an application. - externalDocs: - url: '' LinkCustomEvaluationResponse: type: object properties: @@ -45404,12 +36570,6 @@ components: description: Response returned after linking. externalDocs: url: '' - ListActionsRequest: - type: object - additionalProperties: false - description: This data structure represents the request to list Actions. - externalDocs: - url: '' ListActionsResponse: type: object properties: @@ -45425,35 +36585,6 @@ components: Actions. externalDocs: url: '' - ListAiApplicationsRequest: - type: object - properties: - evaluationTypes: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EvaluationType' - description: >- - Optional filter: only include applications that have at least one - evaluation of any of these types. - pageOffset: - maximum: 10000 - minimum: 0 - type: integer - description: Zero-based page offset. Default 0 if omitted. - format: int64 - pageSize: - maximum: 1000 - minimum: 1 - type: integer - description: Number of items per page. Default 200 if omitted. - format: int32 - description: >- - Request to list AI applications with optional pagination and - evaluation-type filter. - externalDocs: - url: '' ListAiApplicationsResponse: type: object properties: @@ -45467,40 +36598,6 @@ components: description: Response containing a page of AI applications. externalDocs: url: '' - ListAiEvaluationsRequest: - type: object - properties: - application: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Filter by application name. - evaluationType: - allOf: - - $ref: '#/components/schemas/EvaluationType' - description: Filter by evaluation type. - pageOffset: - maximum: 10000 - minimum: 0 - type: integer - description: Zero-based page offset. Default 0 if omitted. - format: int64 - pageSize: - maximum: 1000 - minimum: 1 - type: integer - description: Number of items per page. Default 200 if omitted. - format: int32 - subsystem: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Filter by subsystem. - description: Request to list AI evaluations with optional filters and pagination. - externalDocs: - url: '' ListAiEvaluationsResponse: type: object properties: @@ -45514,31 +36611,6 @@ components: description: Response containing a page of AI evaluations. externalDocs: url: '' - ListAlertDefsRequest: - title: List alert definitions request - type: object - properties: - includeAccessPermissions: - type: boolean - description: >- - When true, populate the response's per-alert access map with the - caller's access decision and each alert's raw access policy. - Defaults to false. - orderBys: - allOf: - - $ref: '#/components/schemas/AlertDefOrderByList' - description: Ordering settings for the list of alert definitions - pagination: - allOf: - - $ref: '#/components/schemas/alerts.v3.PaginationRequest' - description: Pagination settings for the list of alert definitions - queryFilter: - allOf: - - $ref: '#/components/schemas/AlertDefQueryFilter' - description: Filter to apply to the list of alert definitions - description: A request to get list of alert definitions - externalDocs: - url: '' ListAlertDefsResponse: title: List alert definitions response type: object @@ -45564,55 +36636,6 @@ components: description: A response that contains a list of alert definitions externalDocs: url: '' - ListAlertEventsRequest: - title: ListAlertEventsRequest - required: - - alertIds - - timestampRange - type: object - properties: - alertIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: Alert version IDs to filter events by - description: Alert version IDs to filter events by - example: - - 32144a8a-7ee0-4c16-a093-2bf1f9c12e1e - cxEventLabels: - type: object - additionalProperties: - minLength: 0 - type: string - description: Optional event labels to filter by (e.g., app, subsystem, region) - orderBys: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/events.v3.OrderBy' - description: Ordering criteria for the returned events. - pagination: - allOf: - - $ref: '#/components/schemas/events.v3.PaginationRequest' - description: Pagination parameters for the response. - timestampRange: - allOf: - - $ref: '#/components/schemas/TimestampRange' - description: Time range to search for events - description: Request to list events associated with specific alerts. - externalDocs: - url: '' - ListAlertEventsRequest.CxEventLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string ListAlertEventsResponse: title: ListAlertEventsResponse required: @@ -45630,12 +36653,6 @@ components: description: Response containing events associated with the alert externalDocs: url: '' - ListAllOutgoingWebhooksRequest: - title: List all outgoing webhooks request - type: object - additionalProperties: false - externalDocs: - url: '' ListAllOutgoingWebhooksResponse: title: List all outgoing webhooks response type: object @@ -45649,28 +36666,6 @@ components: description: Response containing a list of all outgoing webhooks. externalDocs: url: '' - ListCasesRequest: - title: List cases request - type: object - properties: - filters: - allOf: - - $ref: '#/components/schemas/CaseFilters' - description: Filters to apply when listing cases - orderBy: - allOf: - - $ref: '#/components/schemas/CaseOrderBy' - description: >- - Sorting parameters to control the order of returned cases. Supports - single-field sorting only. Example: sort by priority in descending - order to show highest priority cases first. - pagination: - allOf: - - $ref: '#/components/schemas/cases.v1.PaginationRequest' - description: Pagination parameters - description: Request to list cases with filtering and pagination - externalDocs: - url: '' ListCasesResponse: title: List cases response required: @@ -45698,23 +36693,6 @@ components: description: Response containing a list of cases and pagination information externalDocs: url: '' - ListConnectorSummariesRequest: - title: List Connector Summaries Request - type: object - properties: - connectorType: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: Filter connector summaries by their type. - supportedByEntityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Filter connector summaries by the entity type they support. - description: Request to list summaries of connectors with optional filtering - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListConnectorSummariesResponse: title: List Connector Summaries Response type: object @@ -45731,23 +36709,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ListConnectorsRequest: - title: List Connectors Request - type: object - properties: - connectorType: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: Filter connectors by their type. - supportedByEntityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Filter connectors by the entity type they support. - description: Request to list connectors with optional filtering - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListConnectorsResponse: title: List Connectors Response type: object @@ -45764,19 +36725,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ListCustomEvaluationsForApplicationRequest: - type: object - properties: - applicationId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI application. - description: Request to list custom evaluations linked to a specific application. - externalDocs: - url: '' ListCustomEvaluationsForApplicationResponse: type: object properties: @@ -45790,14 +36738,6 @@ components: description: Response containing custom evaluations linked to the application. externalDocs: url: '' - ListCustomRolesRequest: - type: object - properties: - teamId: - minimum: 0 - type: integer - description: Team identifier. - format: int64 ListCustomRolesResponse: type: object properties: @@ -45810,14 +36750,6 @@ components: description: Response containing a list of custom roles. externalDocs: url: '' - ListDashboardFoldersRequest: - title: List dashboard folders request data structure - type: object - additionalProperties: false - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ ListDashboardFoldersResponse: title: List dashboard folders response data structure type: object @@ -45834,9 +36766,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - ListE2MRequest: - type: object - additionalProperties: false ListE2MResponse: title: List E2M Response required: @@ -45857,21 +36786,6 @@ components: description: Find out more about events2metrics url: >- https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ - ListEntitySubTypesRequest: - title: List Entity Sub Types - type: object - properties: - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Entity type whose sub-types to list. - description: >- - Request to list entity subtypes by entity type supported by Notification - Center - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListEntitySubTypesResponse: type: object properties: @@ -45887,19 +36801,6 @@ components: description: Response containing a list of notification entity sub-types. externalDocs: url: '' - ListEntityTypeAttachmentTypesRequest: - title: List Entity Type Attachment Types - type: object - properties: - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Entity type whose supported attachment types to list. - description: Request to list supported attachment types for a given entity type - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListEntityTypeAttachmentTypesResponse: type: object properties: @@ -45915,15 +36816,6 @@ components: type. externalDocs: url: '' - ListEntityTypesRequest: - title: List Entity Types - type: object - additionalProperties: false - description: Request to list entity types supported by Notification Center - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListEntityTypesResponse: type: object properties: @@ -45937,19 +36829,6 @@ components: description: Response containing a list of notification entity types. externalDocs: url: '' - ListEventsCountRequest: - title: ListEventsCountRequest - required: - - filter - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/EventsFilter' - description: Filter criteria for events. - description: This data structure represents a request to list events count - externalDocs: - url: '' ListEventsCountResponse: title: ListEventsCountResponse required: @@ -45971,28 +36850,6 @@ components: description: This data structure represents a response to list events count externalDocs: url: '' - ListGlobalRoutersRequest: - title: List Global Routers Request - type: object - properties: - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Deprecated. Filter routers by entity type. - deprecated: true - sourceEntityLabels: - type: object - additionalProperties: - $ref: '#/components/schemas/EntityLabelValues' - description: >- - Filter routers by source entity labels. Each entry restricts results - to routers whose source entity has the matching label values. If - empty, all routers are returned. - description: Request to retrieve global routers by entity type or all - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ListGlobalRoutersResponse: title: List Global Routers Response type: object @@ -46009,52 +36866,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ListHotStoreConfigsRequest: - type: object - additionalProperties: false - ListHotStoreConfigsResponse: - type: object - properties: - configs: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/HotStoreConfig' - ListIbmEventNotificationsInstancesRequest: - type: object - additionalProperties: false - ListIbmEventNotificationsInstancesResponse: - type: object - properties: - instances: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/EventNotificationsInstance' - ListIncidentAggregationsRequest: - title: List incident aggregations request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentQueryFilter' - description: Filter for incidents - groupBys: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/GroupBy' - description: Group by fields for aggregation - pagination: - allOf: - - $ref: '#/components/schemas/incidents.v1.PaginationRequest' - description: Pagination parameters - description: >- - Request to get aggregated incident data with filtering and grouping - options - externalDocs: - url: '' ListIncidentAggregationsResponse: title: List incident aggregations response required: @@ -46076,33 +36887,6 @@ components: description: Response containing aggregated incident data and pagination information externalDocs: url: '' - ListIncidentEventRequestOrderBy: - title: List incident events order by request - type: object - properties: - direction: - allOf: - - $ref: '#/components/schemas/v1.OrderByDirection' - description: Sort direction (ascending or descending) - example: ORDER_BY_DIRECTION_ASC - field: - allOf: - - $ref: '#/components/schemas/IncidentEventOrderByFieldType' - description: Field to order by - example: INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED - externalDocs: - url: '' - ListIncidentEventsFilterValuesRequest: - title: List incident events filter values request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentEventQueryFilter' - description: Filter for incident events - description: A request to get available filter values for incident events - externalDocs: - url: '' ListIncidentEventsFilterValuesResponse: title: List incident events filter values response type: object @@ -46114,30 +36898,6 @@ components: description: A response containing available filter values for incident events externalDocs: url: '' - ListIncidentEventsRequest: - title: List incident events request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentEventQueryFilter' - description: Filter for incident events - orderBy: - allOf: - - $ref: '#/components/schemas/ListIncidentEventRequestOrderBy' - description: Order by fields for incident events - pagination: - allOf: - - $ref: '#/components/schemas/incidents.v1.PaginationRequest' - description: >- - Pagination parameters. This request accepts at most 1000 items per - page, and defaults to 100 when pageSize is omitted; the shared - maximum of 10000 does not apply here. - description: >- - Request to list incident events with filtering, pagination and ordering - options - externalDocs: - url: '' ListIncidentEventsResponse: title: List incident events response required: @@ -46160,17 +36920,6 @@ components: information externalDocs: url: '' - ListIncidentEventsTotalCountRequest: - title: List incident events total count request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentEventQueryFilter' - description: Filter for incident events - description: A request to get the total count of incident events matching a filter - externalDocs: - url: '' ListIncidentEventsTotalCountResponse: title: List incident events total count response type: object @@ -46191,30 +36940,6 @@ components: whether the count limit was reached externalDocs: url: '' - ListIncidentsRequest: - title: List incidents request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentQueryFilter' - description: Filter for incidents - orderBys: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/v1.OrderBy' - description: Order by fields - pagination: - allOf: - - $ref: '#/components/schemas/incidents.v1.PaginationRequest' - description: Pagination parameters - description: >- - Request to list incidents with filtering, pagination and ordering - options - externalDocs: - url: '' ListIncidentsResponse: title: List incidents response required: @@ -46234,40 +36959,6 @@ components: description: Response containing a list of incidents and pagination information externalDocs: url: '' - ListLabelsCardinalityRequest: - type: object - oneOf: - - required: - - spansQuery - type: object - - required: - - logsQuery - type: object - - type: object - not: - anyOf: - - required: - - spansQuery - type: object - - required: - - logsQuery - type: object - properties: - logsQuery: - allOf: - - $ref: '#/components/schemas/v2.LogsQuery' - description: Logs-based query used to evaluate label cardinality. - metricLabels: - maxItems: 10 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MetricLabel' - description: The metric labels to evaluate cardinality for. - spansQuery: - allOf: - - $ref: '#/components/schemas/v2.SpansQuery' - description: Spans-based query used to evaluate label cardinality. ListLabelsCardinalityResponse: type: object properties: @@ -46281,9 +36972,6 @@ components: description: Response containing label cardinality data for events-to-metrics rules. externalDocs: url: '' - ListManagedIntegrationKeysRequest: - type: object - additionalProperties: false ListManagedIntegrationKeysResponse: title: List managed integration keys response type: object @@ -46300,29 +36988,6 @@ components: description: Response containing a list of managed integration keys. externalDocs: url: '' - ListNotificationDeliveriesRequest: - title: List notification deliveries request - required: - - caseIds - type: object - properties: - caseIds: - maxItems: 1000 - minItems: 1 - type: array - items: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Case IDs to retrieve notification deliveries for - description: Case IDs to retrieve notification deliveries for - example: - - 3f166e9f-3c88-4af2-b52e-138f339dab3e - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 - description: Request to retrieve notification delivery records for one or more cases. - externalDocs: - url: '' ListNotificationDeliveriesResponse: title: List notification deliveries response required: @@ -46337,12 +37002,6 @@ components: description: Response containing a list of notification delivery records for cases. externalDocs: url: '' - ListOutboundWebhooksSummaryRequest: - title: List outbound webhooks summary request - type: object - additionalProperties: false - externalDocs: - url: '' ListOutboundWebhooksSummaryResponse: title: List outbound webhooks summary response type: object @@ -46356,12 +37015,6 @@ components: description: Response containing summary information for outgoing webhooks. externalDocs: url: '' - ListOutgoingWebhookTypesRequest: - title: List outgoing webhook types request - type: object - additionalProperties: false - externalDocs: - url: '' ListOutgoingWebhookTypesResponse: title: List outgoing webhook types response type: object @@ -46375,16 +37028,6 @@ components: description: Response containing a list of available outgoing webhook types. externalDocs: url: '' - ListOutgoingWebhooksRequest: - title: List outgoing webhooks request - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/WebhookType' - description: The outgoing webhook type to filter the listing by. - externalDocs: - url: '' ListOutgoingWebhooksResponse: title: List outgoing webhooks response type: object @@ -46398,18 +37041,6 @@ components: description: Response containing a list of outgoing webhooks. externalDocs: url: '' - ListPresetSummariesRequest: - type: object - properties: - connectorType: - allOf: - - $ref: '#/components/schemas/notification_center.ConnectorType' - description: Filter preset summaries by their connector type. - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - description: Filter preset summaries by their entity type. - example: ALERTS ListPresetSummariesResponse: type: object properties: @@ -46423,36 +37054,6 @@ components: description: Response containing a list of notification preset summaries. externalDocs: url: '' - ListRepositoriesRequest: - type: object - additionalProperties: false - description: Request to list the repository settings. Resolved from auth context. - externalDocs: - url: '' - ListRepositoriesResponse: - type: object - properties: - repositories: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RepositorySetting' - description: The repository settings. - description: Response containing the repository settings. - externalDocs: - url: '' - ListResponse: - type: object - properties: - rules: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/metrics_blocking_rules.Rule' - ListRuleGroupsRequest: - type: object - additionalProperties: false ListRuleGroupsResponse: type: object properties: @@ -46465,19 +37066,6 @@ components: description: Response containing a list of parsing rule groups. externalDocs: url: '' - ListSlosRequest: - title: ListSlosRequest - type: object - properties: - filters: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SloFilter' - description: The filters. - description: Request to list SLOs with optional filters. - externalDocs: - url: '' ListSlosResponse: title: ListSlosResponse required: @@ -46493,9 +37081,6 @@ components: description: Response containing a list of SLOs. externalDocs: url: '' - ListSystemRolesRequest: - type: object - additionalProperties: false ListSystemRolesResponse: type: object properties: @@ -46508,12 +37093,6 @@ components: description: Response containing a list of system roles. externalDocs: url: '' - ListTeamsRequest: - type: object - additionalProperties: false - description: Request to list the teams in the calling user's organization. - externalDocs: - url: '' ListTeamsResponse: type: object properties: @@ -46557,17 +37136,6 @@ components: description: A team and the quota and retention settings assigned to it. externalDocs: url: '' - ListTenantConfigsRequest: - type: object - additionalProperties: false - ListTenantConfigsResponse: - type: object - properties: - tenantConfigs: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TenantConfig' ListTextValue: title: List text value type: object @@ -46606,9 +37174,6 @@ components: description: List value. externalDocs: url: '' - ListViewFoldersRequest: - type: object - additionalProperties: false ListViewFoldersResponse: type: object properties: @@ -46622,9 +37187,6 @@ components: description: Response containing a list of view folders. externalDocs: url: '' - ListViewsRequest: - type: object - additionalProperties: false ListViewsResponse: type: object properties: @@ -46638,31 +37200,6 @@ components: description: Response containing a list of views. externalDocs: url: '' - LiveErrorLogEntry: - type: object - properties: - errorLog: - minLength: 0 - type: string - executedAtEpochMs: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - source: - minLength: 0 - type: string - LiveErrorLogSourceStat: - type: object - properties: - errorLogCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - source: - minLength: 0 - type: string LocalChangelog: title: Local changelog type: object @@ -46677,26 +37214,6 @@ components: description: Local changelog. externalDocs: url: '' - Log: - type: object - properties: - metadata: - type: object - additionalProperties: - minLength: 0 - type: string - text: - minLength: 0 - type: string - Log.MetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string LogAttachment: title: Log attachment required: @@ -46832,16 +37349,6 @@ components: - LOG_SEVERITY_ERROR - LOG_SEVERITY_CRITICAL type: string - LogSeverityLevel: - enum: - - LOG_SEVERITY_LEVEL_UNSPECIFIED - - LOG_SEVERITY_LEVEL_DEBUG - - LOG_SEVERITY_LEVEL_VERBOSE - - LOG_SEVERITY_LEVEL_INFO - - LOG_SEVERITY_LEVEL_WARNING - - LOG_SEVERITY_LEVEL_ERROR - - LOG_SEVERITY_LEVEL_CRITICAL - type: string Logs: title: LogsQuery type: object @@ -47026,45 +37533,6 @@ components: description: Learn more about logs anomaly alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/anomaly-detection-alerts/ - LogsAvro: - type: object - additionalProperties: false - LogsCount: - title: Logs Count - type: object - properties: - applicationName: - minLength: 0 - type: string - description: The application name. - logsCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: The logs count. - example: '100' - priority: - $ref: '#/components/schemas/v2.Priority' - severity: - $ref: '#/components/schemas/datausage.v2.Severity' - subsystemName: - minLength: 0 - type: string - description: The subsystem name. - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - description: This data structure represents a logs count. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - LogsImmediateNotification: - type: object - additionalProperties: false LogsImmediateType: title: Logs immediate alert type type: object @@ -47557,26 +38025,6 @@ components: - LOGS_THRESHOLD_CONDITION_TYPE_NOT_EQUALS type: string description: Logs threshold condition type. - LogsThresholdNotification: - type: object - properties: - conditionType: - $ref: '#/components/schemas/LogsThresholdConditionType' - countResult: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - isUndetectedValue: - type: boolean - toTimestamp: - minLength: 0 - type: string - format: date-time LogsThresholdRule: title: Logs Threshold Rule type: object @@ -48130,118 +38578,6 @@ components: description: Max. externalDocs: url: '' - Measurement: - type: object - properties: - appendableMetrics: - minItems: 0 - type: array - items: - minLength: 0 - type: string - dataSource: - $ref: '#/components/schemas/DataSource' - dataSourceType: - $ref: '#/components/schemas/DataSourceType' - description: - minLength: 0 - type: string - description: Human-readable description. - displayName: - minLength: 0 - type: string - groupLeft: - minLength: 0 - type: string - id: - minLength: 0 - type: string - joinOn: - minLength: 0 - type: string - labels: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - logicalGroup: - minLength: 0 - type: string - measurementName: - minLength: 0 - type: string - orderingQuery: - minLength: 0 - type: string - deprecated: true - query: - minLength: 0 - type: string - subjectLabel: - minLength: 0 - type: string - MeasurementMetadata: - type: object - properties: - aggregationType: - $ref: '#/components/schemas/AggregationType' - aggregationWindowSeconds: - type: integer - format: int32 - measurementName: - minLength: 0 - type: string - queryType: - $ref: '#/components/schemas/v1.QueryType' - step: - type: integer - format: int32 - topkAggregation: - $ref: '#/components/schemas/TopkAggregation' - MeasurementQuery: - type: object - properties: - aggregationType: - $ref: '#/components/schemas/AggregationType' - aggregationWindowSeconds: - type: integer - format: int32 - description: - minLength: 0 - type: string - description: Human-readable description. - displayName: - minLength: 0 - type: string - description: The display name. - labelValues: - $ref: '#/components/schemas/LabelValues' - logicalGroup: - minLength: 0 - type: string - name: - minLength: 0 - type: string - description: Display name. - orderingQuery: - minLength: 0 - type: string - query: - minLength: 0 - type: string - queryResults: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryResult' - queryType: - $ref: '#/components/schemas/v1.QueryType' - step: - type: integer - format: int32 MessageConfig: type: object properties: @@ -48467,30 +38803,6 @@ components: description: Learn more about metric-based anomaly alerts in our documentation url: >- https://coralogix.com/docs/user-guides/alerting/create-an-alert/metrics/anomaly-detection-alerts/ - MetricDailyExtra: - title: Metric Daily Extra - required: - - sampleCount - type: object - properties: - sampleCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Total sample count for the day. - description: Additional daily totals for metric-level queries. - externalDocs: - url: '' - MetricEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string MetricFilter: title: Metric filter configuration in alerts type: object @@ -48599,53 +38911,6 @@ components: description: Configuration for handling missing values in metric threshold alerts. externalDocs: url: '' - MetricNameStats: - type: object - properties: - metricName: - minLength: 0 - type: string - uniqueLabelNameCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - MetricRecordExtra: - title: Metric Record Extra - required: - - dimensionsCount - - variationsCount - - sampleCount - - fractionOfDailySampleCount - type: object - properties: - dimensionsCount: - maximum: 4294967295 - minimum: 0 - type: integer - description: Number of label dimensions. - format: int64 - fractionOfDailySampleCount: - maximum: 1 - minimum: 0 - type: number - description: Share of daily sample count (0 when skip_totals). - format: float - sampleCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Sample count for this metric. - variationsCount: - maximum: 4294967295 - minimum: 0 - type: integer - description: Number of variations. - format: int64 - description: Additional fields for metric-level usage records. - externalDocs: - url: '' MetricThresholdCondition: title: Metric Threshold Condition type: object @@ -48686,33 +38951,6 @@ components: - METRIC_THRESHOLD_CONDITION_TYPE_NOT_EQUALS type: string description: Metric threshold condition type. - MetricThresholdNotification: - type: object - properties: - avgValueOverThreshold: - type: number - format: double - conditionType: - $ref: '#/components/schemas/MetricThresholdConditionType' - fromTimestamp: - minLength: 0 - type: string - format: date-time - isUndetectedValue: - type: boolean - maxValueOverThreshold: - type: number - format: double - minValueOverThreshold: - type: number - format: double - pctOverThreshold: - type: number - format: double - toTimestamp: - minLength: 0 - type: string - format: date-time MetricThresholdRule: title: Metric Threshold Rule type: object @@ -49036,13 +39274,6 @@ components: description: Microsoft teams config. externalDocs: url: '' - MigrateTenantRequest: - type: object - properties: - tenantId: - minimum: 0 - type: integer - format: int64 Min: type: object properties: @@ -49157,72 +39388,6 @@ components: description: Monthly. externalDocs: url: '' - MoreThanConditionOperator: - type: object - additionalProperties: false - MoreThanOrEqualsConditionOperator: - type: object - additionalProperties: false - MoveQuotaRequest: - required: - - destinationTeam - - unitsToMove - type: object - properties: - destinationTeam: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team the quota is given to. - sourceTeam: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team the quota is taken from. - unitsToMove: - minimum: 0 - exclusiveMinimum: true - type: number - description: >- - Amount of daily quota to move, in quota units per day. Must be - greater than zero; to move quota the other way, call the operation - on the other team. - format: double - description: >- - Request to move daily quota from one team to another within the same - organization. - externalDocs: - url: '' - MoveQuotaResponse: - type: object - properties: - destinationTeamQuota: - type: number - description: >- - Daily quota of the destination team after the move, in quota units - per day. - format: double - sourceTeamQuota: - type: number - description: >- - Daily quota of the source team after the move, in quota units per - day. - format: double - description: Response containing the daily quota of both teams after the move. - externalDocs: - url: '' - MultiGroup: - type: object - properties: - fields: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FieldGroup' - values: - minItems: 0 - type: array - items: - type: number - format: double MultiSelect: type: object properties: @@ -49504,21 +39669,6 @@ components: items: minLength: 0 type: string - NamedInterval: - type: object - properties: - durationMs: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - name: - minLength: 0 - type: string - description: Display name. - NewValueNotification: - type: object - additionalProperties: false NextOp: enum: - NEXT_OP_AND_OR_UNSPECIFIED @@ -49830,15 +39980,6 @@ components: description: Numeric value label. externalDocs: url: '' - ObjectTag: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string ObservationField: type: object properties: @@ -49858,20 +39999,6 @@ components: description: Observation field. externalDocs: url: '' - ObservedDetails: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - ratio: - type: number - format: double - toTimestamp: - minLength: 0 - type: string - format: date-time OllyAnalysis: title: Olly analysis type: object @@ -49956,32 +40083,6 @@ components: - OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_HIGH type: string description: Confidence level Olly assigns to the root-cause hypothesis. - OllyAnalysisSettings: - type: object - properties: - createTime: - minLength: 0 - type: string - format: date-time - enabled: - type: boolean - id: - minLength: 0 - type: string - monthlyCapacity: - type: integer - format: int32 - ownershipLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FilterGroup' - priorityFilter: - $ref: '#/components/schemas/CasePriorityFilter' - updateTime: - minLength: 0 - type: string - format: date-time OllyAnalysisStatus: enum: - STATUS_UNSPECIFIED @@ -50012,28 +40113,6 @@ components: description: Opsgenie config. externalDocs: url: '' - OrderActionsRequest: - type: object - properties: - privateActionsOrder: - type: object - additionalProperties: - maximum: 4294967295 - minimum: 0 - type: integer - format: int64 - description: The private actions order. - sharedActionsOrder: - type: object - additionalProperties: - maximum: 4294967295 - minimum: 0 - type: integer - format: int64 - description: The shared actions order. - description: This data structure represents the request to order Actions. - externalDocs: - url: '' OrderActionsResponse: type: object additionalProperties: false @@ -50053,20 +40132,6 @@ components: - ORDER_BY_ALERT_EVENT_FIELDS_TIMESTAMP type: string description: Order by alert event fields. - OrderByList: - title: Order by list - type: object - properties: - orderBys: - maxItems: 20 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/alerts.v3.OrderBy' - description: Order by fields - description: List of fields to order by - externalDocs: - url: '' OrderDirection: enum: - ORDER_DIRECTION_UNSPECIFIED @@ -50092,13 +40157,6 @@ components: description: Ordering field. externalDocs: url: '' - OrganisationId: - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. OriginatorType: enum: - ORIGINATOR_TYPE_UNSPECIFIED @@ -50151,15 +40209,6 @@ components: description: Find out more about recording rules url: >- https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ - OutRule.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string OutRuleGroup: title: Out Rule Group required: @@ -50654,28 +40703,6 @@ components: $ref: '#/components/schemas/WebhookType' externalDocs: url: '' - OutputSetStats: - title: Output Set Stats - required: - - matchedCount - - datasetLastUpdatedEpochSeconds - type: object - properties: - datasetLastUpdatedEpochSeconds: - maximum: 4294967295 - minimum: 0 - type: integer - description: Unix epoch seconds when the underlying dataset was last updated. - format: int64 - matchedCount: - maximum: 4294967295 - minimum: 0 - type: integer - description: Total distinct keys matching filters before pagination. - format: int64 - description: Metadata about a paginated result set. - externalDocs: - url: '' Owner: type: object oneOf: @@ -50775,42 +40802,6 @@ components: description: Pager duty config. externalDocs: url: '' - PagerDutyService: - type: object - properties: - id: - maxLength: 32 - minLength: 1 - pattern: ^[A-Z0-9]+$ - type: string - description: The service id. - name: - minLength: 0 - type: string - Pagination: - type: object - properties: - limit: - type: integer - format: int32 - offset: - type: integer - format: int32 - PaginationData: - type: object - properties: - orderBy: - $ref: '#/components/schemas/v1.SortOrder' - orderByMeasurement: - minLength: 0 - type: string - pageIndex: - type: integer - format: int32 - pageSize: - type: integer - description: Page size. - format: int32 Parameter: title: Parameter type: object @@ -50882,15 +40873,6 @@ components: description: String value for this integration parameter. externalDocs: url: '' - ParametersEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string ParseParameters: type: object properties: @@ -50905,12 +40887,6 @@ components: description: Parse parameters. externalDocs: url: '' - PartitioningScheme: - enum: - - PARTITIONING_SCHEME_UNSPECIFIED - - PARTITIONING_SCHEME_DT_HR - - PARTITIONING_SCHEME_NONE - type: string Percentile: type: object properties: @@ -50987,24 +40963,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - Permutation.PermutationLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string - PermutationEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string PieChart.DataprimeQuery: title: DataprimeQuery type: object @@ -51285,96 +41243,6 @@ components: description: Configuration for the PII evaluation. externalDocs: url: '' - PillarType: - enum: - - PILLAR_SOURCE - - PILLAR_PRIORITY - - PILLAR_METRIC_NAME - - PILLAR_SERVICE_NAME - type: string - description: Dimension to group metric usage aggregates by. - PillarValue: - title: Pillar Value - type: object - oneOf: - - required: - - source - type: object - - required: - - priority - type: object - - required: - - metricName - type: object - - required: - - serviceName - type: object - - type: object - not: - anyOf: - - required: - - source - type: object - - required: - - priority - type: object - - required: - - metricName - type: object - - required: - - serviceName - type: object - properties: - metricName: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Metric name. - priority: - allOf: - - $ref: '#/components/schemas/metrics.Priority' - description: Metric priority. - serviceName: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Service name from the service_name label. - source: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Source indicator (e.g. apm, recording_rules). - description: Value for one group-by pillar. - externalDocs: - url: '' - PinDashboardRequest: - title: Pin dashboard request data structure - required: - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the pin request, used to prevent duplicate - operations. - description: This is a request used to mark certain dashboard as pinned - externalDocs: - description: Find out more about Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ PinDashboardResponse: title: Pin dashboard response data structure type: object @@ -51410,13 +41278,6 @@ components: description: Placement. externalDocs: url: '' - PlanType: - enum: - - PLAN_TYPE_UNSPECIFIED - - PLAN_TYPE_POST_TRIAL - - PLAN_TYPE_PLAN - - PLAN_TYPE_TRIAL - type: string Policy: title: Policy required: @@ -51582,26 +41443,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - PolicySettings: - title: Policy Settings - type: object - properties: - logsPolicySettings: - $ref: '#/components/schemas/LogsPolicySettings' - spansPolicySettings: - $ref: '#/components/schemas/SpansPolicySettings' - description: Policy settings for both logs and spans for a company. - externalDocs: - url: '' - PostInstallationStepsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string Preset: title: Preset type: object @@ -51774,14 +41615,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - PresetsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/Preset' PriorityAggregation: title: Priority aggregation type: object @@ -51849,22 +41682,6 @@ components: description: Priority details changed case event. externalDocs: url: '' - PriorityList: - title: Priority List - required: - - priorities - type: object - properties: - priorities: - maxItems: 10 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/metrics.Priority' - description: Priorities to match. - description: List of priorities for filtering. - externalDocs: - url: '' PriorityOverride: type: object properties: @@ -51881,25 +41698,6 @@ components: description: Priority override status. externalDocs: url: '' - PrivateActionsOrderEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minimum: 0 - type: integer - format: int64 - ProcessTagsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string ProductTypeValues: type: object properties: @@ -52018,15 +41816,6 @@ components: description: Data describing a single Prometheus alert within an alert group. externalDocs: url: '' - PrometheusAlert.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string PrometheusAlertIndicator: title: Prometheus alert indicator required: @@ -52103,15 +41892,6 @@ components: alerts. externalDocs: url: '' - PrometheusAlertIndicator.GroupLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string PrometheusAlertManager: title: Prometheus AlertManager resolver type: object @@ -52459,12 +42239,6 @@ components: description: The replace value. type: $ref: '#/components/schemas/ValuesMappingType' - ProviderType: - enum: - - PROVIDER_TYPE_UNSPECIFIED - - PROVIDER_TYPE_S3 - - PROVIDER_TYPE_IBM_COS - type: string PushBasedContextualData: title: Push based contextual data type: object @@ -52888,63 +42662,6 @@ components: description: Query display settings for time series lines multi-query visualization externalDocs: url: '' - QueryResult: - type: object - properties: - metric: - type: object - additionalProperties: - minLength: 0 - type: string - values: - minItems: 0 - type: array - items: - type: array - items: - type: object - QuerySeriesVisibility: - title: QuerySeriesVisibility - required: - - query - type: object - properties: - query: - allOf: - - $ref: '#/components/schemas/SeriesVisibilityQueryMatcher' - description: Match series by query id - seriesNames: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: >- - When visibility is SHOW_ONLY: list of series names to display - (matches the final rendered series name after applying - series_name_template if present) - description: >- - When visibility is SHOW_ONLY: list of series names to display - (matches the final rendered series name after applying - series_name_template if present) - example: - - staging - - production - threshold: - allOf: - - $ref: '#/components/schemas/SeriesVisibilityThresholdMatcher' - description: >- - Match series by threshold label (when legend is grouped by - thresholds) - visibility: - allOf: - - $ref: '#/components/schemas/SeriesVisibilityMode' - description: >- - Visibility mode for the query series - hide all or show only - specific series - description: Query series visibility config - externalDocs: - url: '' QuerySource.DataprimeQuery: type: object properties: @@ -52997,8 +42714,12 @@ components: minLength: 1 pattern: ^[\s\S]*$ type: string - description: The log regex. - description: Query.logs query.type.field name. + description: The log regex. Not implemented — see the parent schema. + description: >- + Not implemented and unusable. Fetching log field names by regex is + defined in the API but is not supported by the dashboards product: a + dashboard whose variable uses fieldName cannot be created in the UI and + fails to render when loaded. Use fieldValue instead. externalDocs: url: '' QuerySource.LogsQuery.Type.FieldValue: @@ -53269,8 +42990,12 @@ components: minLength: 1 pattern: ^[\s\S]*$ type: string - description: The span regex. - description: Fetches distinct span field names matching the given regex pattern. + description: The span regex. Not implemented — see the parent schema. + description: >- + Not implemented and unusable. Fetching span field names by regex is + defined in the API but is not supported by the dashboards product: a + dashboard whose variable uses fieldName cannot be created in the UI and + fails to render when loaded. Use fieldValue instead. externalDocs: url: '' QuerySource.SpansQuery.Type.FieldValue: @@ -53281,18 +43006,22 @@ components: - $ref: '#/components/schemas/ObservationField' description: >- The span observation field to fetch values for. Preferred over - value. + value. Setting both observationField and value is rejected. value: allOf: - $ref: '#/components/schemas/SpanField' description: >- Deprecated. Legacy span field addressing. Use observationField - instead; do not set both. + instead. Setting both value and observationField is rejected. deprecated: true description: >- - Fetches distinct values for a specific span field. Set observationField - to choose the field; value is a deprecated legacy alternative — prefer - observationField and avoid setting both. + Fetches distinct values for a specific span field. Exactly one of + observationField or value must be set — setting both is rejected. The + exclusivity is enforced when the request is validated, not by this + schema: both properties are declared independently and are individually + optional, so a both-set or neither-set object is only rejected once the + request is sent. Prefer observationField; value is a deprecated legacy + alternative. externalDocs: url: '' QueryText: @@ -53310,170 +43039,6 @@ components: description: Query text. externalDocs: url: '' - QueryUsage: - type: object - properties: - errorCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - errorRate: - type: number - format: float - executionCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - lastRun: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - pattern: - minLength: 0 - type: string - sources: - minItems: 0 - type: array - items: - minLength: 0 - type: string - successCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - QueryUsageDay: - type: object - properties: - date: - $ref: '#/components/schemas/Date' - usage: - $ref: '#/components/schemas/QueryUsageExtended' - QueryUsageExtended: - type: object - properties: - errorCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - errorRate: - type: number - format: float - executionCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - groupedExecutionStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/GroupedExecutionStats' - lastRun: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - sources: - minItems: 0 - type: array - items: - minLength: 0 - type: string - successCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - QueryUsagesBySourceUri: - type: object - properties: - errorCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - errorRate: - type: number - format: float - executionCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - lastRun: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - source: - minLength: 0 - type: string - sourceUri: - minLength: 0 - type: string - successCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - QueryUsagesBySourceUriSourceStats: - type: object - properties: - source: - minLength: 0 - type: string - sourceUriCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - QueryUsagesBySourceUrisDay: - type: object - properties: - date: - $ref: '#/components/schemas/Date' - matchedCount: - minimum: 0 - type: integer - format: int64 - queryUsagesBySourceUris: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsagesBySourceUri' - sourceStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsagesBySourceUriSourceStats' - QueryUsagesDay: - type: object - properties: - datasetLastUpdatedEpochSeconds: - minimum: 0 - type: integer - format: int64 - date: - $ref: '#/components/schemas/Date' - matchedCount: - minimum: 0 - type: integer - format: int64 - queryUsages: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QueryUsage' - sourceStats: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SourceStat' QuickTimeSelection: required: - seconds @@ -53602,15 +43167,6 @@ components: description: Quota based status. externalDocs: url: '' - Range.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string RangeMapping: title: RangeMapping type: object @@ -53633,32 +43189,6 @@ components: description: Range-based color mapping using min/max bounds and color thresholds externalDocs: url: '' - RatioThresholdNotification: - type: object - properties: - conditionType: - $ref: '#/components/schemas/LogsRatioConditionType' - denominatorCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - numeratorCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - ratio: - type: number - format: float - toTimestamp: - minLength: 0 - type: string - format: date-time Recipients: title: Recipients type: object @@ -53679,23 +43209,6 @@ components: description: List of email recipients for alert notifications externalDocs: url: '' - RecreateCompanyMeasurementsRequest: - type: object - properties: - measurementIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - RecreateCompanyMeasurementsResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' Recurrence: type: object properties: @@ -53869,159 +43382,6 @@ components: $ref: '#/components/schemas/RevisionLifecycle' externalDocs: url: '' - RemoteConfiguration: - type: object - properties: - agentSelector: - allOf: - - $ref: '#/components/schemas/AgentSelectorResponse' - description: Flat agent attributes that match agents for this configuration. - createdAt: - maxLength: 64 - minLength: 0 - type: string - description: Time when this remote configuration was created. - format: date-time - hash: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: SHA-256 hash of the normalized raw configuration content. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ - type: string - description: Remote configuration UUID v7. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Remote configuration name. - rawConfiguration: - maxLength: 1048576 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Normalized OpenTelemetry Collector configuration YAML. - updatedAt: - maxLength: 64 - minLength: 0 - type: string - description: Time when this remote configuration was last updated. - format: date-time - description: Remote configuration returned by Fleet Manager. - externalDocs: - url: '' - RemoteConfigurationCreate: - type: object - properties: - agentSelector: - allOf: - - $ref: '#/components/schemas/AgentSelectorRequest' - description: Flat agent attributes that match agents for this configuration. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Remote configuration name. - rawConfiguration: - maxLength: 1048576 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - OpenTelemetry Collector configuration YAML. The supervisor-managed - OpAMP extension must not be configured. - description: Remote configuration to create. - externalDocs: - url: '' - RemoteConfigurationReplace: - type: object - properties: - agentSelector: - allOf: - - $ref: '#/components/schemas/AgentSelectorRequest' - description: Flat agent attributes that match agents for this configuration. - name: - maxLength: 256 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Remote configuration name. - rawConfiguration: - maxLength: 1048576 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - OpenTelemetry Collector configuration YAML. The supervisor-managed - OpAMP extension must not be configured. - description: Remote configuration content used in a family update. - externalDocs: - url: '' - RemoveCompanyMeasurementsRequest: - type: object - properties: - measurementIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - RemoveCompanyMeasurementsResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - RemoveCustomLabelMappingsRequest: - type: object - properties: - ids: - minItems: 0 - type: array - items: - minLength: 0 - type: string - RemoveCustomLabelMappingsResponse: - type: object - properties: - numberOfDeletedMappings: - type: integer - format: int32 - RemoveEnrichmentsRequest: - title: Encrichments Delettion Request - required: - - enrichmentIds - type: object - properties: - enrichmentIds: - maxItems: 1000 - minItems: 0 - type: array - items: - maximum: 2147483647 - minimum: 0 - type: integer - description: The unique identifiers of the enrichment rules to delete. - format: int64 - description: The unique identifiers of the enrichment rules to delete. - example: - - 1 - - 2 - - 3 - description: Request data structure for enrichments deletion - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ RemoveEnrichmentsResponse: title: Encrichments Delettion Response type: object @@ -54052,94 +43412,6 @@ components: description: Remove fields parameters. externalDocs: url: '' - RemoveGlobalMeasurementsInternalRequest: - type: object - properties: - measurementIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - RemoveGlobalMeasurementsInternalResponse: - type: object - properties: - numberOfDeletedMeasurements: - type: integer - format: int32 - RemoveLabelMappingsRequest: - type: object - properties: - ids: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The ids. - description: The ids. - RemoveLabelMappingsResponse: - type: object - properties: - numberOfDeletedMappings: - type: integer - format: int32 - RemoveMeasurementsRequest: - type: object - properties: - measurementIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - RemoveMeasurementsResponse: - type: object - properties: - numberOfDeletedMeasurements: - type: integer - format: int32 - RenderedConnectorConfigField: - type: object - properties: - fieldName: - minLength: 0 - type: string - value: - minLength: 0 - type: string - description: The value. - RenderedMessageConfigField: - type: object - properties: - fieldName: - minLength: 0 - type: string - value: - minLength: 0 - type: string - description: The value. - ReorderPoliciesRequest: - title: Reorder Policies Request - required: - - orders - - sourceType - type: object - properties: - orders: - maxItems: 200 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/PolicyOrder' - description: The orders. - sourceType: - $ref: '#/components/schemas/v1.SourceType' - description: This data structue is used to reorder policies. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ ReorderPoliciesResponse: title: Reorder Policies Response required: @@ -54189,33 +43461,6 @@ components: description: This data structure represents the response to replace an Action. externalDocs: url: '' - ReplaceAlertDefRequest: - title: Replace alert definition request - type: object - properties: - accessPolicy: - allOf: - - $ref: '#/components/schemas/AccessPolicyAction' - description: >- - Change to the alert's access policy: upsert a raw policy, or delete - (remove) the existing one. Optional; if omitted, the existing policy - is left unchanged. Changing the access policy requires the - alerts:UpdateAccessPolicy permission. - alertDefProperties: - allOf: - - $ref: '#/components/schemas/AlertDefProperties' - description: The properties of the alert definition - id: - maxLength: 36 - minLength: 0 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Alert definition ID - example: 123e4567-e89b-12d3-a456-426614174000 - description: A request to replace an existing alert definition - externalDocs: - url: '' ReplaceAlertDefResponse: title: Replace alert definition response type: object @@ -54227,62 +43472,6 @@ components: description: A response that contains the updated alert definition externalDocs: url: '' - ReplaceApmSloRequest: - type: object - properties: - apmSlo: - $ref: '#/components/schemas/ApmSloInput' - id: - minLength: 0 - type: string - description: Unique identifier. - metricSource: - $ref: '#/components/schemas/ApmSource' - revision: - $ref: '#/components/schemas/v1.Revision' - silenceDataValidations: - type: boolean - deprecated: true - ReplaceApmSloResponse: - type: object - properties: - effectedSloAlertIds: - minItems: 0 - type: array - items: - minLength: 0 - type: string - slo: - $ref: '#/components/schemas/ApmSlo' - ReplaceCompanyIpAccessSettingsRequest: - title: Replace company IP access settings request - type: object - properties: - enableCoralogixCustomerSupportAccess: - allOf: - - $ref: '#/components/schemas/CoralogixCustomerSupportAccess' - description: >- - The Coralogix customer support access setting. Defaults to DISABLED - if not provided. - example: CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED - id: - minLength: 0 - type: string - description: >- - Unique identifier of the existing IP access settings resource to - replace. - example: d662a2f1-21c3-493c-8f8a-595d3ab05ef3 - ipAccess: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/IpAccess' - description: List of IP access entries to replace. - description: >- - This data structure represents the request to replace company IP access - settings. - externalDocs: - url: '' ReplaceCompanyIpAccessSettingsResponse: title: Replace company IP access settings response type: object @@ -54296,37 +43485,6 @@ components: settings. externalDocs: url: '' - ReplaceConfigurationGroupRequest: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/ConfigurationGroupReplace' - description: Configuration group fields to update. - description: Request to update a fleet-manager configuration group. - externalDocs: - url: '' - ReplaceConfigurationGroupResponse: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/ConfigurationGroup' - description: Updated configuration group. - description: Response containing the updated fleet-manager configuration group. - externalDocs: - url: '' - ReplaceConnectorRequest: - title: Replace Connector Request - type: object - properties: - connector: - $ref: '#/components/schemas/Connector' - description: Request to replace an existing connector - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ReplaceConnectorResponse: title: Replace Connector Response type: object @@ -54338,17 +43496,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ReplaceCustomPresetRequest: - title: Replace Custom Preset Request - type: object - properties: - preset: - $ref: '#/components/schemas/Preset' - description: Request to replace an existing custom preset - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ReplaceCustomPresetResponse: title: Replace Custom Preset Response type: object @@ -54360,27 +43507,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - ReplaceDashboardFolderRequest: - title: Replace dashboard folder request data structure - type: object - properties: - folder: - allOf: - - $ref: '#/components/schemas/DashboardFolder' - description: The folder. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the replace folder request, used to prevent - duplicate updates. - description: Request to replace an existing dashboard folder. - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ ReplaceDashboardFolderResponse: title: Replace dashboard folder response data structure type: object @@ -54390,43 +43516,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - ReplaceDashboardRequest: - title: Replace dashboard request data structure - required: - - requestId - - dashboard - type: object - properties: - accessPolicy: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: >- - JSON string representing the access policy for this dashboard. - Defines granular permissions for users and groups. - example: >- - {"version":"2025-01-01","default":{"permissions":{"team-dashboards:Read":"grant","team-dashboards:Update":"deny","team-dashboards:ReadAccessPolicy":"grant","team-dashboards:UpdateAccessPolicy":"deny"}},"rules":[]} - dashboard: - $ref: '#/components/schemas/Dashboard' - isLocked: - type: boolean - description: The is locked. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the replace request, used to prevent duplicate - updates. - description: >- - This is a request sent to update an existing dashboard with new - information - externalDocs: - description: Find out more Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ ReplaceDashboardResponse: title: Replace dashboard response data structure type: object @@ -54436,32 +43525,6 @@ components: description: Find out more Dashboards in our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - ReplaceDefaultDashboardRequest: - title: Replace default dashboard request data structure - required: - - requestId - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the replace default dashboard request, used to - prevent duplicate operations. - description: This is a request to replace a default dashboard - externalDocs: - description: Find out more about Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ ReplaceDefaultDashboardResponse: title: Replace default dashboard response data structure type: object @@ -54505,17 +43568,6 @@ components: description: Find out more about events2metrics url: >- https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ - ReplaceGlobalRouterRequest: - title: Replace Global Router Request - type: object - properties: - router: - $ref: '#/components/schemas/GlobalRouter' - description: Request which updates an existing global router - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ReplaceGlobalRouterResponse: title: Replace Global Router Response type: object @@ -54545,20 +43597,6 @@ components: description: Replace parameters. externalDocs: url: '' - ReplacePolicySettingsRequest: - title: Replace Policy Settings Request - type: object - properties: - logsPolicySettings: - $ref: '#/components/schemas/LogsPolicySettings' - spansPolicySettings: - $ref: '#/components/schemas/SpansPolicySettings' - description: >- - This data structure is used to replace default policy priority settings - for logs and/or spans. Server-generated fields (created_at, updated_at) - will be ignored if provided. - externalDocs: - url: '' ReplacePolicySettingsResponse: title: Replace Policy Settings Response type: object @@ -54572,17 +43610,6 @@ components: contains the complete resource including server-generated fields. externalDocs: url: '' - ReplaceQuotaAllocationRuleSetRequest: - title: Replace quota allocation rule set request - required: - - ruleSet - type: object - properties: - ruleSet: - $ref: '#/components/schemas/QuotaAllocationEntityTypeRuleSet' - description: Request to replace quota allocation rule set - externalDocs: - url: '' ReplaceQuotaAllocationRuleSetResponse: title: Replace quota allocation rule set response type: object @@ -54594,17 +43621,6 @@ components: replaced externalDocs: url: '' - ReplaceSloAlertsValidationsRequest: - title: ReplaceSloAlertsValidationsRequest - required: - - slo - type: object - properties: - slo: - $ref: '#/components/schemas/Slo' - description: Request to validate alerts before replacing an existing SLO. - externalDocs: - url: '' ReplaceSloAlertsValidationsResponse: title: ReplaceSloAlertsValidationsResponse required: @@ -54654,52 +43670,6 @@ components: description: Response after replacing an existing SLO. externalDocs: url: '' - ReplaceViewFolderRequest: - type: object - properties: - folder: - $ref: '#/components/schemas/ViewFolder' - ReplaceViewFolderResponse: - type: object - properties: - folder: - $ref: '#/components/schemas/ViewFolder' - ReplaceViewRequest: - type: object - properties: - view: - $ref: '#/components/schemas/View' - ReplaceViewResponse: - type: object - properties: - view: - $ref: '#/components/schemas/View' - RepositoryClassification: - enum: - - REPOSITORY_CLASSIFICATION_UNSPECIFIED - - MANAGED - - UNMANAGED - type: string - description: 'Classification of a repository: MANAGED or UNMANAGED.' - RepositorySetting: - required: - - repository - - classification - type: object - properties: - classification: - allOf: - - $ref: '#/components/schemas/RepositoryClassification' - description: Classification of the repository. - repository: - maxLength: 512 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9._/-]*$ - type: string - description: Repository (bare name, e.g. 'coralogix' or 'coralogix/repo'). - description: A single repository and its classification. - externalDocs: - url: '' RequestBasedMetricSli: title: RequestBasedMetricSli type: object @@ -54711,29 +43681,6 @@ components: description: Definition of a request-based SLI based on metrics externalDocs: url: '' - RequestBasedPermutationData: - type: object - properties: - badEvents: - minimum: 0 - type: integer - format: int64 - deprecated: true - badEventsV2: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - goodEvents: - minimum: 0 - type: integer - format: int64 - deprecated: true - goodEventsV2: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string ResolutionDetails: title: Resolution details type: object @@ -54782,33 +43729,6 @@ components: description: Resolution reason changed case event. externalDocs: url: '' - ResolveCaseRequest: - title: Resolve case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to resolve. Accepts either the case UUID (the `id` - field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - reason: - maxLength: 500 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Reason to resolve - example: This case is not applicable. - description: Request to mark a case as resolved. - externalDocs: - url: '' ResolveCaseResponse: title: Resolve case response required: @@ -54822,22 +43742,6 @@ components: description: Response containing the case after it has been resolved. externalDocs: url: '' - ResolveIncidentByEventIdRequest: - title: Resolve incidents request - required: - - eventId - type: object - properties: - eventId: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Event ID associated to the Incident to resolve - example: event_id_1 - description: Request to resolve one or more incidents - externalDocs: - url: '' ResolveIncidentByEventIdResponse: title: Acknowledge incident by event id response required: @@ -54851,30 +43755,6 @@ components: description: Response containing the updated incident after resolution externalDocs: url: '' - ResolveIncidentsRequest: - title: Resolve incidents request - required: - - incidentIds - type: object - properties: - incidentIds: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of incident IDs to resolve - description: List of incident IDs to resolve - example: - - 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - - 9c858901-8a57-4791-81fe-4c455b099bc9 - description: Request to resolve one or more incidents - externalDocs: - url: '' ResolveIncidentsResponse: title: Resolve incidents response required: @@ -54915,14 +43795,6 @@ components: description: Status payload for a resolved Prometheus alert. externalDocs: url: '' - ResolvedWidgetsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/Widget' ResponseStatus: title: ResponseStatus required: @@ -54944,15 +43816,6 @@ components: description: Status of the response, including error code and message. externalDocs: url: '' - ResponseStatus.DetailsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string RestrictedTopicsConfig: type: object properties: @@ -54970,23 +43833,6 @@ components: description: Configuration for the RestrictedTopics evaluation. externalDocs: url: '' - RetentionPolicy: - title: Retenion Policy - type: object - properties: - resolution: - type: integer - format: int32 - example: 12 - retentionDays: - type: integer - format: int32 - example: 30 - description: This data structure represents the retention policy for a tenant. - externalDocs: - description: Find out more about metrics cost optimization - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ RetentionPolicyRequest: title: Retenion Policy Request type: object @@ -55173,14 +44019,6 @@ components: description: Information about a notification router. externalDocs: url: '' - RoutersEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/GlobalRouter' RoutingLabels: title: Routing Labels type: object @@ -55247,15 +44085,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - RoutingRule.CustomDetailsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string RoutingTarget: title: Routing Target type: object @@ -55290,15 +44119,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - RoutingTarget.CustomDetailsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string Row: type: object properties: @@ -55341,29 +44161,6 @@ components: - ROW_STYLE_LIST type: string description: Row style. - RuleExpression: - type: object - oneOf: - - required: - - byMetricName - type: object - - required: - - byApmServiceName - type: object - - type: object - not: - anyOf: - - required: - - byMetricName - type: object - - required: - - byApmServiceName - type: object - properties: - byApmServiceName: - $ref: '#/components/schemas/ByApmServiceName' - byMetricName: - $ref: '#/components/schemas/ByMetricName' RuleGroup: type: object properties: @@ -55409,14 +44206,6 @@ components: description: Rule group. externalDocs: url: '' - RuleGroupListing: - type: object - properties: - ruleGroups: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/OutRuleGroup' RuleGroupSetListing: title: Rule Group Set Listing required: @@ -55712,9 +44501,6 @@ components: description: Find out more about metrics cost optimization url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ - S3TargetServiceGetTargetRequest: - type: object - additionalProperties: false S3TargetServiceGetTargetResponse: title: Get Target Response required: @@ -55728,26 +44514,6 @@ components: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - S3TargetServiceSetTargetRequest: - title: Set Target Response - required: - - isActive - - s3 - type: object - properties: - format: - $ref: '#/components/schemas/TargetFormat' - isActive: - type: boolean - description: Whether archiving to this target is active. - example: true - s3: - $ref: '#/components/schemas/S3TargetSpec' - description: This data structure is used to set a storage target for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ S3TargetServiceSetTargetResponse: title: Set Target Response required: @@ -55826,17 +44592,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - Sample: - type: object - properties: - timestamp: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - value: - type: number - format: double SampleType: enum: - SAMPLE_TYPE_UNSPECIFIED @@ -55844,15 +44599,6 @@ components: - SAMPLE_TYPE_MAX type: string description: Sample type. - SaveContextualDataIntegrationRequest: - title: Save contextual data integration request - type: object - properties: - metadata: - $ref: '#/components/schemas/IntegrationMetadata' - description: Request for creating a contextual data integration. - externalDocs: - url: '' SaveContextualDataIntegrationResponse: title: Save contextual data integration response type: object @@ -55868,15 +44614,6 @@ components: integration. externalDocs: url: '' - SaveIntegrationRequest: - title: Save integration request - type: object - properties: - metadata: - $ref: '#/components/schemas/IntegrationMetadata' - description: Request for creating an integration deployment. - externalDocs: - url: '' SaveIntegrationResponse: title: Save integration response type: object @@ -55983,88 +44720,6 @@ components: propertyName: actionType externalDocs: url: '' - ScopesFilter: - title: Scopes Filter - type: object - properties: - application: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of application names to filter on (OR logic, full match). - example: application1 - description: List of application names to filter on (OR logic, full match). - subsystem: - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: List of subsystem names to filter on (OR logic, full match). - example: subsystem1 - description: List of subsystem names to filter on (OR logic, full match). - description: This data structure represents a filter for scopes. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - SearchClause: - title: Search Clause - type: object - oneOf: - - required: - - id - type: object - - required: - - name - type: object - - type: object - not: - anyOf: - - required: - - id - type: object - - required: - - name - type: object - properties: - id: - maximum: 2147483647 - minimum: 0 - type: integer - description: Search by the numeric ID of the custom enrichment. - format: int64 - example: 1 - name: - maxLength: 255 - minLength: 1 - pattern: ^\w+$ - type: string - description: Search by the name of the custom enrichment. - example: custom_enrichment_name - description: This data structure represents a search clause - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - SearchCustomEnrichmentDataRequest: - title: Search Custom Enrichment Data Request - type: object - properties: - searchClauses: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SearchClause' - description: Search clauses used to filter custom enrichment data. - description: This request data structure is used to search custom enrichment data - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ SearchCustomEnrichmentDataResponse: type: object properties: @@ -56095,40 +44750,6 @@ components: description: Search query. externalDocs: url: '' - SearchUsersRequest: - title: SearchUsersRequest - type: object - properties: - pageSize: - minimum: 0 - type: integer - description: Number of results per page - format: int64 - pageToken: - minimum: 0 - type: integer - description: Token for pagination to retrieve the next page of results - format: int64 - status: - allOf: - - $ref: '#/components/schemas/UserStatus' - description: Optional filter by user status (e.g., 'active', 'inactive') - teamId: - minimum: 0 - type: integer - description: Team ID to search within - format: int64 - username: - minLength: 0 - type: string - description: Optional filter by username (partial match supported) - description: >- - Request to search for users within a team using optional filters for - username and status. Supports pagination for large result sets. - externalDocs: - description: Find out more about user management - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ SearchUsersResponse: title: SearchUsersResponse type: object @@ -56245,14 +44866,6 @@ components: description: Selected filters. externalDocs: url: '' - SelectedValuesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - type: boolean SelectionType: enum: - SELECTION_TYPE_UNSPECIFIED @@ -56306,79 +44919,6 @@ components: description: Sensitive data placeholder. externalDocs: url: '' - SerializedDataprimeQuery: - type: object - properties: - data: - minLength: 0 - type: string - format: byte - SeriesVisibility: - title: SeriesVisibility - type: object - properties: - annotationSeries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/AnnotationSeriesVisibility' - description: List of annotation series visibility settings - querySeries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/QuerySeriesVisibility' - description: List of query series visibility settings - description: Configuration for specifying which series should be visible on a widget - externalDocs: - url: '' - SeriesVisibilityMode: - enum: - - SERIES_VISIBILITY_MODE_UNSPECIFIED - - SERIES_VISIBILITY_MODE_HIDE_ALL - - SERIES_VISIBILITY_MODE_SHOW_ONLY - type: string - SeriesVisibilityQueryMatcher: - title: SeriesVisibilityQueryMatcher - required: - - queryId - type: object - properties: - queryId: - minLength: 0 - type: string - description: Unique identifier of the query - description: Match series by query id - externalDocs: - url: '' - SeriesVisibilityThresholdMatcher: - title: SeriesVisibilityThresholdMatcher - required: - - thresholdLabel - type: object - properties: - thresholdLabel: - minLength: 0 - type: string - description: Label of the threshold to match (matches Threshold.label) - description: Match series by threshold label - externalDocs: - url: '' - ServiceDailyExtra: - title: Service Daily Extra - required: - - sampleCount - type: object - properties: - sampleCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Total sample count for the day. - description: Additional daily totals for service-level queries. - externalDocs: - url: '' ServiceNow: title: ServiceNow resolver type: object @@ -56427,110 +44967,6 @@ components: platform externalDocs: url: '' - ServiceRecordExtra: - title: Service Record Extra - required: - - sampleCount - - fractionOfDailySampleCount - type: object - properties: - fractionOfDailySampleCount: - maximum: 1 - minimum: 0 - type: number - description: Share of daily sample count (0 when skip_totals). - format: float - sampleCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Sample count for this service. - description: Additional fields for service-level usage records. - externalDocs: - url: '' - SetAiCenterCodeAgentsRequest: - required: - - pairs - type: object - properties: - pairs: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/SetCodeAgentPair' - description: >- - The product and integration type pairs to mark as successfully - integrated. Duplicate pairs are accepted and collapsed. - description: >- - Request to mark one or more product and integration type pairs as - successfully integrated. Team is resolved from auth context. Idempotent: - pairs that are already marked succeed unchanged. - externalDocs: - url: '' - SetAiCenterCodeAgentsResponse: - type: object - properties: - codeAgents: - maxItems: 50 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CodeAgentIntegration' - description: >- - The full, updated list of code agents marked as successfully - integrated, each with its marked integration types. This is the - team's whole set, not just the pairs sent. - description: >- - Response containing the full, updated list of code agents marked as - successfully integrated, each with its marked integration types. - externalDocs: - url: '' - SetCodeAgentPair: - required: - - product - - integrationType - type: object - properties: - integrationType: - allOf: - - $ref: '#/components/schemas/CodeAgentIntegrationType' - description: >- - How this product's data reaches Coralogix. - CODE_AGENT_INTEGRATION_TYPE_UNSPECIFIED is rejected with HTTP 400. - product: - allOf: - - $ref: '#/components/schemas/AiCenterProduct' - description: >- - The AI product to mark as successfully integrated. - AI_CENTER_PRODUCT_UNSPECIFIED is rejected with HTTP 400. - description: >- - A single product and integration type pair to mark as successfully - integrated. - externalDocs: - url: '' - SetCompanyModelPricingRequest: - required: - - prices - type: object - properties: - prices: - type: object - additionalProperties: - $ref: '#/components/schemas/ModelPrice' - description: Full replacement map of model name to custom price. - description: Request to set (replace) the company's custom model pricing. - externalDocs: - url: '' - SetCompanyModelPricingRequest.PricesEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/ModelPrice' SetCompanyModelPricingResponse: type: object properties: @@ -56541,110 +44977,12 @@ components: description: Response containing the updated company model pricing. externalDocs: url: '' - SetCustomPresetAsDefaultRequest: - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the custom preset to set as default. SetCustomPresetAsDefaultResponse: type: object additionalProperties: false description: Response returned after setting a custom preset as the default. externalDocs: url: '' - SetDailyQuotaRequest: - required: - - targetDailyQuota - type: object - properties: - targetDailyQuota: - minimum: 0 - type: number - description: Daily quota to assign to the team, in quota units per day. - format: float - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team whose daily quota is set. - description: Request to set the daily quota of a team. - externalDocs: - url: '' - SetDailyQuotaResponse: - type: object - additionalProperties: false - description: Empty response returned after setting a team's daily quota. - externalDocs: - url: '' - SetExternalTargetRequest: - title: Set External Target Request - required: - - isActive - - companyId - type: object - oneOf: - - required: - - s3 - type: object - - required: - - ibmCos - type: object - properties: - companyId: - minimum: 0 - type: integer - format: int64 - example: 1234567 - ibmCos: - $ref: '#/components/schemas/IBMCosTargetSpec' - isActive: - type: boolean - example: true - s3: - $ref: '#/components/schemas/S3TargetSpec' - description: >- - This data structure is obtained after setting an external storage target - for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - SetExternalTargetResponse: - title: Set Target Response - required: - - target - type: object - properties: - target: - $ref: '#/components/schemas/v2.Target' - description: >- - This data structure is obtained after setting an external storage target - for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - SetIDPParametersRequest: - title: Set IDP Parameters Request - type: object - properties: - params: - $ref: '#/components/schemas/IDPParameters' - teamId: - minimum: 0 - type: integer - description: Team identifier. - format: int64 - description: >- - This data structure is used to set the parameters of a SAML identity - provider - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ SetIDPParametersResponse: type: object additionalProperties: false @@ -56653,53 +44991,12 @@ components: parameters. externalDocs: url: '' - SetPresetAsDefaultRequest: - title: Set Preset As Default Request - type: object - properties: - id: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The unique identifier of the preset to set as default. - description: Request to set custom or system preset as default - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ SetPresetAsDefaultResponse: type: object additionalProperties: false description: Response returned after setting a preset as the default. externalDocs: url: '' - SetPriorityOverrideRequest: - title: Set priority override request - required: - - id - - priority - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case. Accepts either the case UUID (the `id` field on a - case) or the readable identifier (the `readable_id` field, e.g. - `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - priority: - allOf: - - $ref: '#/components/schemas/CasePriority' - description: Priority value to override with - example: CASE_PRIORITY_P1 - description: Request to override a case's computed priority with a specific value. - externalDocs: - url: '' SetPriorityOverrideResponse: title: Set priority override response required: @@ -56734,47 +45031,6 @@ components: description: Set scope id. externalDocs: url: '' - SetTargetRequest: - title: Set Target Response - required: - - isActive - type: object - oneOf: - - required: - - s3 - type: object - - required: - - ibmCos - type: object - properties: - format: - $ref: '#/components/schemas/TargetFormat' - ibmCos: - $ref: '#/components/schemas/IBMCosTargetSpec' - isActive: - type: boolean - description: The is active. - example: true - s3: - $ref: '#/components/schemas/S3TargetSpec' - description: This data structure is used to set a storage target for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - SetTargetResponse: - title: Set Target Response - required: - - target - type: object - properties: - target: - $ref: '#/components/schemas/v2.Target' - description: This data structure is obtained after setting a storage target for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ SeverityConstraint: type: object properties: @@ -56791,16 +45047,6 @@ components: description: Configuration for the Sexism evaluation (no fields). externalDocs: url: '' - SharedActionsOrderEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minimum: 0 - type: integer - format: int64 SingleBooleanValue: title: Single boolean value type: object @@ -56811,15 +45057,6 @@ components: description: Single boolean value. externalDocs: url: '' - SingleHourWindow: - type: object - properties: - date: - $ref: '#/components/schemas/Date' - hour: - minimum: 0 - type: integer - format: int64 SingleStringValue: type: object properties: @@ -57064,15 +45301,6 @@ components: description: Definition of an SLO externalDocs: url: '' - Slo.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string SloAlertValidityResult: type: object properties: @@ -57092,22 +45320,6 @@ components: minLength: 0 type: string description: Display name. - SloBurnRateThresholdNotification: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - pctOverThreshold: - type: number - format: double - shortWindow: - $ref: '#/components/schemas/SloShortWindowNotification' - toTimestamp: - minLength: 0 - type: string - format: date-time SloConstantFilterField: enum: - SLO_CONST_FILTER_FIELD_UNSPECIFIED @@ -57115,43 +45327,6 @@ components: - SLO_CONST_FILTER_FIELD_SLO_NAME type: string description: Slo constant filter field. - SloData: - type: object - properties: - incompleteData: - type: boolean - minCompliance: - type: number - format: float - minRemainingErrorBudget: - type: number - format: float - statusCount: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/SloStatusCount' - SloError: - type: object - properties: - errorDetails: - $ref: '#/components/schemas/ErrorDetails' - errorType: - $ref: '#/components/schemas/ErrorType' - SloErrorBudgetThresholdNotification: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - pctOverThreshold: - type: number - format: double - toTimestamp: - minLength: 0 - type: string - format: date-time SloExecutionRequest: title: SloExecutionRequest type: object @@ -57210,145 +45385,6 @@ components: description: Response for an executed SLO operation. externalDocs: url: '' - SloFilter: - title: SloFilter - type: object - properties: - field: - $ref: '#/components/schemas/SloFilterField' - predicate: - $ref: '#/components/schemas/SloFilterPredicate' - description: A filter for SLOs, consisting of a field and a predicate - externalDocs: - url: '' - SloFilterField: - title: SloFilterField - type: object - oneOf: - - required: - - constFilter - type: object - - required: - - labelName - type: object - - required: - - sloType - type: object - - required: - - productType - type: object - - required: - - serviceName - type: object - - required: - - ownershipServiceValues - type: object - - required: - - ownershipEnvironmentValues - type: object - - required: - - ownershipTeamValues - type: object - - type: object - not: - anyOf: - - required: - - constFilter - type: object - - required: - - labelName - type: object - - required: - - sloType - type: object - - required: - - productType - type: object - - required: - - serviceName - type: object - - required: - - ownershipServiceValues - type: object - - required: - - ownershipEnvironmentValues - type: object - - required: - - ownershipTeamValues - type: object - properties: - constFilter: - $ref: '#/components/schemas/SloConstantFilterField' - labelName: - minLength: 0 - type: string - description: Filter by a specific SLO label key. - example: environment - ownershipEnvironmentValues: - allOf: - - $ref: '#/components/schemas/StringValues' - description: >- - Filter by the SLO ownership environment tag (static or resolved). IN - semantics: match if the value equals any of the given strings. - Applies whenever the SLO has ownership configured for environment; - not limited to a specific product type. - ownershipServiceValues: - allOf: - - $ref: '#/components/schemas/StringValues' - description: >- - Filter by the SLO ownership service tag (static or resolved). IN - semantics: match if the value equals any of the given strings. - Applies whenever the SLO has ownership configured for service; not - limited to a specific product type. - ownershipTeamValues: - allOf: - - $ref: '#/components/schemas/StringValues' - description: >- - Filter by the SLO ownership team tag (static or resolved). IN - semantics: match if the value equals any of the given strings. - Applies whenever the SLO has ownership configured for team; not - limited to a specific product type. - productType: - type: boolean - description: Filter discriminator for SLO product type values. - serviceName: - minLength: 0 - type: string - description: >- - Filter by service name from the APM SLI services list (not ownership - tags). Only valid for APM product SLOs. MUST be used together with a - product_type filter that includes APM; the server may reject the - request otherwise. To filter by configured ownership service on any - SLO type, use ownership_service_values instead. - example: payment-service - sloType: - type: boolean - description: Filter discriminator for SLO type values. - description: Field used for filtering SLOs - externalDocs: - url: '' - SloFilterPredicate: - title: SloFilterPredicate - type: object - properties: - is: - $ref: '#/components/schemas/IsFilterPredicate' - description: Predicate used for filtering SLOs - externalDocs: - url: '' - SloHubRow: - type: object - properties: - errorMessage: - minLength: 0 - type: string - deprecated: true - slo: - $ref: '#/components/schemas/Slo' - sloData: - $ref: '#/components/schemas/SloData' - sloError: - $ref: '#/components/schemas/SloError' SloLink: title: SLO link type: object @@ -57362,52 +45398,6 @@ components: description: Deep link to the SLO overview for an alert indicator on a case. externalDocs: url: '' - SloMetricFilter: - type: object - properties: - promql: - minLength: 0 - type: string - SloMetricMissingValues: - type: object - oneOf: - - required: - - replaceWithZero - type: object - - required: - - minNonNullValuesPct - type: object - - type: object - not: - anyOf: - - required: - - replaceWithZero - type: object - - required: - - minNonNullValuesPct - type: object - properties: - minNonNullValuesPct: - minimum: 0 - type: integer - format: int64 - replaceWithZero: - type: boolean - SloMetricThresholdConditionType: - enum: - - METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED - - METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_EQUALS - type: string - SloMetricTimeWindow: - type: object - properties: - sloMetricTimeWindowSpecificValue: - $ref: '#/components/schemas/SloMetricTimeWindowValue' - SloMetricTimeWindowValue: - enum: - - SLO_METRIC_TIME_WINDOW_VALUE_UNSPECIFIED - - SLO_METRIC_TIME_WINDOW_VALUE_1_MINUTE - type: string SloOwnershipTag: title: SloOwnershipTag type: object @@ -57488,73 +45478,12 @@ components: SloOwnershipTag per dimension; omit a dimension when unset. externalDocs: url: '' - SloPermutationData: - type: object - oneOf: - - required: - - requestBasedPermutationData - type: object - - required: - - windowBasedPermutationData - type: object - - type: object - not: - anyOf: - - required: - - requestBasedPermutationData - type: object - - required: - - windowBasedPermutationData - type: object - properties: - compliance: - type: number - format: float - group: - $ref: '#/components/schemas/GroupValue' - incompleteData: - type: boolean - remainingErrorBudget: - type: number - format: float - requestBasedPermutationData: - $ref: '#/components/schemas/RequestBasedPermutationData' - status: - $ref: '#/components/schemas/SloStatus' - windowBasedPermutationData: - $ref: '#/components/schemas/WindowBasedPermutationData' SloProductType: enum: - SLO_PRODUCT_TYPE_UNSPECIFIED - SLO_PRODUCT_TYPE_APM type: string description: Slo product type. - SloShortWindowNotification: - type: object - properties: - pctOverThreshold: - type: number - format: double - SloStatus: - enum: - - SLO_STATUS_UNSPECIFIED - - SLO_STATUS_OK - - SLO_STATUS_WARNING - - SLO_STATUS_CRITICAL - - SLO_STATUS_BREACHED - - SLO_STATUS_PENDING - type: string - SloStatusCount: - type: object - properties: - count: - minimum: 0 - type: integer - format: int64 - status: - allOf: - - $ref: '#/components/schemas/SloStatus' - description: Status. SloThresholdCondition: title: SLO Threshold Condition type: object @@ -57699,14 +45628,6 @@ components: propertyName: strategyType externalDocs: url: '' - SourceEntityLabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/EntityLabelValues' SourceMapMetadata: title: Source map metadata type: object @@ -57722,17 +45643,6 @@ components: description: Source map metadata. externalDocs: url: '' - SourceStat: - type: object - properties: - patternCount: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - source: - minLength: 0 - type: string SpanField: type: object oneOf: @@ -57837,17 +45747,6 @@ components: description: Span rules. externalDocs: url: '' - SpanTimeRange: - type: object - properties: - end: - minLength: 0 - type: string - format: date-time - start: - minLength: 0 - type: string - format: date-time Spans: title: SpansQuery type: object @@ -57910,66 +45809,6 @@ components: description: Spans aggregation. externalDocs: url: '' - SpansAvro: - type: object - additionalProperties: false - SpansCount: - title: Spans Count - type: object - properties: - errorSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The error span count. - example: '10' - lowErrorSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The low error span count. - example: '5' - lowSuccessSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The low success span count. - example: '50' - mediumErrorSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The medium error span count. - example: '20' - mediumSuccessSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The medium success span count. - example: '200' - successSpanCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - description: The success span count. - example: '100' - timestamp: - minLength: 0 - type: string - description: Timestamp of the event. - format: date-time - example: '2021-01-01T00:00:00.000Z' - description: This data structure represents a spans count. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ SpansFilter: title: SpansFilter type: object @@ -58151,10 +45990,6 @@ components: annotation span. externalDocs: url: '' - SpecialRatioValues: - enum: - - SPECIAL_RATIO_VALUES_INFINITY_OR_UNSPECIFIED - type: string SqlAllowedTablesConfig: type: object properties: @@ -58480,20 +46315,6 @@ components: ORDER_DIRECTION_UNSPECIFIED is rejected. externalDocs: url: '' - Status: - type: object - properties: - code: - type: integer - format: int32 - details: - minItems: 0 - type: array - items: - type: object - message: - minLength: 0 - type: string StatusAggregation: title: Status aggregation type: object @@ -58547,42 +46368,6 @@ components: description: Count for a specific alert status externalDocs: url: '' - StreamDataUsageRequest: - type: object - properties: - query: - $ref: '#/components/schemas/DataUsageQuery' - StreamDataUsageResponse: - type: object - oneOf: - - required: - - header - type: object - - required: - - bucketChunk - type: object - - required: - - trailer - type: object - - type: object - not: - anyOf: - - required: - - header - type: object - - required: - - bucketChunk - type: object - - required: - - trailer - type: object - properties: - bucketChunk: - $ref: '#/components/schemas/BucketChunk' - header: - $ref: '#/components/schemas/Header' - trailer: - $ref: '#/components/schemas/Trailer' StringList: title: String list type: object @@ -58641,15 +46426,6 @@ components: description: Subsystem name constraint. externalDocs: url: '' - Success.MetadataEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string Sum: type: object properties: @@ -58670,25 +46446,6 @@ components: description: Suspicious ip type. externalDocs: url: '' - SyncExternalCaseEventsRequest: - title: Sync external Case events request - required: - - caseId - type: object - properties: - caseId: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to sync external case events for. Accepts either the - case UUID (the `id` field on a case) or the readable identifier (the - `readable_id` field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' SyncExternalCaseEventsResponse: title: Sync external Case events response required: @@ -58701,16 +46458,6 @@ components: description: Response returned after syncing external case events. externalDocs: url: '' - SyncRumDataRequest: - title: Sync RUM data request - type: object - properties: - force: - type: boolean - description: The force. - description: Request for syncing RUM data. - externalDocs: - url: '' SyncRumDataResponse: title: Sync RUM data response type: object @@ -58833,14 +46580,6 @@ components: description: Rule. externalDocs: url: '' - TableRow: - type: object - properties: - queries: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/MeasurementQuery' TableSettings: type: object properties: @@ -58892,15 +46631,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - TagsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string TargetDomain: enum: - ACTION @@ -58922,17 +46652,6 @@ components: - TARGET_FORMAT_CX_DATA_V1 type: string description: Target format. - TeamCount: - type: object - properties: - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: The team id. - teamMemberCount: - minimum: 0 - type: integer - format: int64 TeamGroup: title: TeamGroup type: object @@ -59027,63 +46746,6 @@ components: at the specified timestamp. externalDocs: url: '' - TenantConfig: - type: object - oneOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - - type: object - not: - anyOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - properties: - bucketName: - minLength: 0 - type: string - deprecated: true - disabled: - type: boolean - gcs: - $ref: '#/components/schemas/GcsConfig' - ibm: - $ref: '#/components/schemas/IbmConfig' - indexVersion: - minimum: 0 - type: integer - format: int64 - prefix: - minLength: 0 - type: string - region: - minLength: 0 - type: string - deprecated: true - retentionPolicy: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RetentionPolicy' - s3: - $ref: '#/components/schemas/S3Config' - tenantId: - minimum: 0 - type: integer - format: int64 TenantConfigV2: type: object oneOf: @@ -59152,35 +46814,6 @@ components: description: This data structure represents a Terraform integration. externalDocs: url: '' - TestConnectorConfigRequest: - title: Test Connector Config Request - type: object - properties: - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - fields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/notification_center.ConnectorConfigField' - description: Fields. - payloadType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Payload type to use when testing the connector. - example: default - type: - $ref: '#/components/schemas/notification_center.ConnectorType' - description: Request to test a connector configuration - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ TestConnectorConfigResponse: type: object properties: @@ -59189,21 +46822,6 @@ components: description: Response containing the results of a connector configuration test. externalDocs: url: '' - TestContextualDataIntegrationRequest: - title: Test contextual data integration request - type: object - properties: - integrationData: - $ref: '#/components/schemas/IntegrationMetadata' - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: The unique identifier of the contextual data integration to test. - description: Request for testing a contextual data integration. - externalDocs: - url: '' TestContextualDataIntegrationResponse: title: Test contextual data integration response type: object @@ -59213,56 +46831,6 @@ components: description: Response containing the results of a contextual data integration test. externalDocs: url: '' - TestDestinationRequest: - type: object - properties: - connectorConfigFields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TemplatedConnectorConfigField' - description: The connector config fields. - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The connector id. - entitySubType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Entity sub-type to use when testing the destination. - example: logsImmediateResolved - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - messageConfigFields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/notification_center.MessageConfigField' - description: The message config fields. - payloadType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Payload type to use when testing the destination. - example: default - presetId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The preset id. - description: Request for testing a notification destination. - externalDocs: - url: '' TestDestinationResponse: type: object properties: @@ -59271,25 +46839,6 @@ components: description: Response containing the results of a notification destination test. externalDocs: url: '' - TestExistingConnectorRequest: - type: object - properties: - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The connector id. - payloadType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Payload type to use when testing the connector. - example: default - description: Request for sending a test notification. - externalDocs: - url: '' TestExistingConnectorResponse: type: object properties: @@ -59298,46 +46847,6 @@ components: description: Response containing the results of testing an existing connector. externalDocs: url: '' - TestExistingOutgoingWebhookRequest: - title: Test existing outgoing webhook request - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. - example: example_id - externalDocs: - url: '' - TestExistingPresetRequest: - type: object - properties: - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The connector id. - entitySubType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Entity sub-type to use when testing the preset. - example: logsImmediateResolved - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - presetId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The preset id. - description: Request for testing an existing notification preset. - externalDocs: - url: '' TestExistingPresetResponse: type: object properties: @@ -59346,21 +46855,6 @@ components: description: Response containing the results of testing an existing preset. externalDocs: url: '' - TestIntegrationRequest: - title: Test integration request - type: object - properties: - integrationData: - $ref: '#/components/schemas/IntegrationMetadata' - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: ID of the existing integration instance to test. - description: Request for testing an integration configuration. - externalDocs: - url: '' TestIntegrationResponse: title: Test integration response type: object @@ -59404,15 +46898,6 @@ components: description: Success. externalDocs: url: '' - TestOutgoingWebhookRequest: - title: Test outgoing webhook request - type: object - properties: - data: - $ref: '#/components/schemas/OutgoingWebhookInputData' - description: Request for testing an outgoing webhook configuration. - externalDocs: - url: '' TestOutgoingWebhookResponse: title: Test outgoing webhook response type: object @@ -59491,42 +46976,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - TestPresetConfigRequest: - type: object - properties: - configOverrides: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ConfigOverrides' - description: The config overrides. - connectorId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The connector id. - entitySubType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Entity sub-type to use when testing the preset configuration. - example: metric - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - parentPresetId: - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ - type: string - description: The parent preset id. - description: Request for testing a notification preset configuration. - externalDocs: - url: '' TestPresetConfigResponse: type: object properties: @@ -59593,26 +47042,6 @@ components: description: Indicates the notification test succeeded. externalDocs: url: '' - TestRoutingConditionValidRequest: - title: Test Routing Condition Valid Request - type: object - properties: - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - template: - maxLength: 20000 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Routing condition expression to validate. - example: alertDef.priority == 'P1' - description: Request to check that provided routing condition is valid - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ TestRoutingConditionValidResponse: title: Test Routing Condition Valid Response type: object @@ -59669,30 +47098,6 @@ components: description: Indicates the routing condition is valid, with the evaluated result. externalDocs: url: '' - TestTemplateRenderRequest: - type: object - properties: - entitySubType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Entity sub-type to use when testing template rendering. - example: logsImmediateResolved - entityType: - allOf: - - $ref: '#/components/schemas/notification_center.EntityType' - example: ALERTS - template: - maxLength: 20000 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Template string to test rendering for. - example: '{{ alertDef.name }}' - description: Request for testing notification template rendering. - externalDocs: - url: '' TestTemplateRenderResponse: type: object properties: @@ -60024,45 +47429,6 @@ components: description: Represents a specific time in a 24-hour format externalDocs: url: '' - TimeRangeWithInterval: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - interval: - $ref: '#/components/schemas/NamedInterval' - toTimestamp: - minLength: 0 - type: string - format: date-time - TimeRelativeThresholdNotification: - type: object - properties: - conditionType: - $ref: '#/components/schemas/LogsTimeRelativeConditionType' - fromTimestamp: - minLength: 0 - type: string - format: date-time - latestCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - pastCount: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - ratio: - type: number - format: float - toTimestamp: - minLength: 0 - type: string - format: date-time TimeSelection: type: object oneOf: @@ -60089,15 +47455,6 @@ components: description: Time selection. externalDocs: url: '' - TimeSeries.LabelsEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - minLength: 0 - type: string TimeSeriesBars: type: object properties: @@ -60467,60 +47824,6 @@ components: description: Title changed case event. externalDocs: url: '' - TogglePolicyRequest: - title: Toggle Policy Request - required: - - id - - enabled - type: object - properties: - enabled: - type: boolean - example: true - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - description: This data structue is used to toggle a policy by its ID. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - TogglePolicyResponse: - title: Toggle Policy Response - required: - - id - - enabled - type: object - properties: - enabled: - type: boolean - example: true - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - description: This data structue is obtained when toggling a policy by its ID. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - Token: - type: object - properties: - value: - type: number - description: The value. - format: float - description: Token. - externalDocs: - url: '' TokenOriginType: enum: - TOKEN_ORIGIN_TYPE_UNSPECIFIED @@ -60551,40 +47854,6 @@ components: - TOOLTIP_TYPE_SINGLE type: string description: Tooltip type. - TopBucket: - type: object - properties: - limits: - minItems: 0 - type: array - items: - type: number - format: double - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - value: - type: number - format: double - TopkAggregation: - type: object - properties: - aggregation: - $ref: '#/components/schemas/TopkAggregationType' - topk: - minimum: 0 - type: integer - format: int64 - TopkAggregationType: - enum: - - TOPK_AGGREGATION_TYPE_UNSPECIFIED - - TOPK_AGGREGATION_TYPE_LAST - - TOPK_AGGREGATION_TYPE_MAX - - TOPK_AGGREGATION_TYPE_MIN - - TOPK_AGGREGATION_TYPE_AVG - type: string ToxicityConfig: type: object additionalProperties: false @@ -60634,12 +47903,6 @@ components: description: Filter type for trace entries externalDocs: url: '' - TracingImmediateNotification: - type: object - properties: - traceId: - minLength: 0 - type: string TracingImmediateType: title: Trace-based immediate alert type type: object @@ -60778,22 +48041,6 @@ components: - TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED type: string description: Tracing threshold condition type. - TracingThresholdNotification: - type: object - properties: - count: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - fromTimestamp: - minLength: 0 - type: string - format: date-time - toTimestamp: - minLength: 0 - type: string - format: date-time TracingThresholdRule: title: Trace Threshold Rule type: object @@ -60863,18 +48110,6 @@ components: - TRACING_TIME_WINDOW_VALUE_HOURS_36 type: string description: Tracing time window value. - Trailer: - type: object - properties: - totalBucketChunks: - minimum: 0 - type: integer - format: int64 - totalUsageEntries: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string Triggered: title: Triggered Prometheus alert status required: @@ -60935,25 +48170,6 @@ components: description: Uuid. externalDocs: url: '' - UnacknowledgeCaseRequest: - title: Unacknowledge case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to unacknowledge. Accepts either the case UUID (the - `id` field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' UnacknowledgeCaseResponse: title: Unacknowledge case response required: @@ -60967,25 +48183,6 @@ components: description: Response containing the case after acknowledgment was removed. externalDocs: url: '' - UnassignCaseRequest: - title: Unassign case request - required: - - id - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to unassign. Accepts either the case UUID (the `id` - field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' UnassignCaseResponse: title: Unassign case response required: @@ -60999,30 +48196,6 @@ components: description: Response containing the case after removing its assignee. externalDocs: url: '' - UnassignIncidentsRequest: - title: Unassign incidents request - required: - - incidentIds - type: object - properties: - incidentIds: - maxItems: 10000 - minItems: 1 - type: array - items: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: List of incident IDs to unassign - description: List of incident IDs to unassign - example: - - 3f2504e0-4f89-11d3-9a0c-0305e82c3301 - - 9c858901-8a57-4791-81fe-4c455b099bc9 - description: Request to remove assignments from one or more incidents - externalDocs: - url: '' UnassignIncidentsResponse: title: Unassign incidents response required: @@ -61060,32 +48233,6 @@ components: description: Unassigned case event. externalDocs: url: '' - UndeployExtensionRequest: - title: Revert deployment of extension request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - keptExtensionItems: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: >- - List of extension item IDs to retain after undeploying; all other - items will be removed. - description: >- - List of extension item IDs to retain after undeploying; all other - items will be removed. - description: Request for undeploying an extension. - externalDocs: - url: '' UndeployExtensionResponse: title: Revert deployment of extension response type: object @@ -61102,9 +48249,6 @@ components: description: Response returned after successfully undeploying an extension. externalDocs: url: '' - UniqueCountNotification: - type: object - additionalProperties: false UnknownAssigneeError: title: Unknown assignee error type: object @@ -61119,26 +48263,6 @@ components: description: Change assignee failed event. externalDocs: url: '' - UnlinkCustomEvaluationFromAppRequest: - type: object - properties: - applicationId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI application to unlink from. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the custom evaluation. - description: Request to unlink a custom evaluation from a specific application. - externalDocs: - url: '' UnlinkCustomEvaluationFromAppResponse: type: object properties: @@ -61159,31 +48283,6 @@ components: description: Response returned after unlinking. externalDocs: url: '' - UnpinDashboardRequest: - title: Unpin dashboard request data structure - required: - - dashboardId - type: object - properties: - dashboardId: - maxLength: 21 - minLength: 21 - pattern: ^[\s\S]*$ - type: string - description: The dashboard id. - requestId: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: >- - Idempotency key for the unpin request, used to prevent duplicate - operations. - description: This is a request used to unpin a certain dashboard - externalDocs: - description: Find out more about Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ UnpinDashboardResponse: title: Unpin dashboard response data structure type: object @@ -61200,68 +48299,6 @@ components: description: This data structure represents an untracked integration. externalDocs: url: '' - UpdateAdaptiveRulesRequest: - type: object - properties: - rules: - $ref: '#/components/schemas/AdaptiveRulesUpdate' - UpdateAdaptiveRulesResponse: - type: object - properties: - rules: - $ref: '#/components/schemas/AdaptiveRules' - UpdateAiEvaluationRequest: - type: object - properties: - application: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Name of the AI application this evaluation belongs to. - config: - allOf: - - $ref: '#/components/schemas/EvaluationConfig' - description: Type-specific configuration (oneof). - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the AI evaluation to update. - isEnabled: - type: boolean - description: Whether the evaluation is active. - subsystem: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Subsystem within the application. - target: - allOf: - - $ref: '#/components/schemas/EvaluationTarget' - description: 'What the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION.' - threshold: - maximum: 1 - minimum: 0 - type: number - description: Score threshold. Must be between 0.0 and 1.0 inclusive. - format: double - updateMask: - maxLength: 1024 - minLength: 1 - pattern: ^[a-zA-Z_][a-zA-Z0-9_]*(,[a-zA-Z_][a-zA-Z0-9_]*)*$ - type: string - description: >- - Comma-separated list of field paths to update. When provided, only - the listed fields are touched; a listed field that is absent from - the request body is cleared. When omitted, only fields present in - the body are updated. - description: Request to update an existing AI evaluation. - externalDocs: - url: '' UpdateAiEvaluationResponse: type: object properties: @@ -61298,44 +48335,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - UpdateApiKeyRequest: - title: Update Api Key Request - type: object - properties: - accessPolicy: - minLength: 0 - type: string - description: >- - JSON string representing the access policy for this API key. Defines - granular permissions for users and groups. To delete an existing - policy, pass an empty string. - example: >- - {"version":"2025-01-01","default":{"permissions":{"data-ingest-api-keys:ReadAccessPolicy":"grant","data-ingest-api-keys:Manage":"deny","data-ingest-api-keys:UpdateAccessPolicy":"deny","data-ingest-api-keys:ReadConfig":"grant"}},"rules":[]} - isActive: - type: boolean - description: >- - Whether the API key is active. Set to false to deactivate without - deleting. - example: true - keyId: - minLength: 0 - type: string - description: Key identifier. - example: my_key_id - newName: - minLength: 0 - type: string - description: New display name for the API key. - example: my_new_name - permissions: - $ref: '#/components/schemas/UpdateApiKeyRequest.Permissions' - presets: - $ref: '#/components/schemas/Presets' - description: This data structure is used to update an API key. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ UpdateApiKeyRequest.Permissions: title: Permissions type: object @@ -61359,21 +48358,6 @@ components: description: Response returned after successfully updating an API key. externalDocs: url: '' - UpdateApiKeysStatusRequest: - title: Update API Keys Status Request - type: object - properties: - updates: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ApiKeyStatusUpdate' - description: The updates. - description: This data structure is used to update the status of specified API keys. - externalDocs: - description: Find out more about api keys - url: >- - https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ UpdateApiKeysStatusResponse: title: Update API Keys Status Response type: object @@ -61385,23 +48369,6 @@ components: description: Find out more about api keys url: >- https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/ - UpdateBulkAlertSchedulerRuleRequest: - title: Update bulk alert scheduler rule request data structure - required: - - updateAlertSchedulerRuleRequests - type: object - properties: - updateAlertSchedulerRuleRequests: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UpdateAlertSchedulerRuleRequest' - description: The update alert scheduler rule requests. - description: This is a request sent to update multiple alert scheduler rules - externalDocs: - description: Find out more about alert scheduler rules in our documentation. - url: >- - https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ UpdateBulkAlertSchedulerRuleResponse: title: Update bulk alert scheduler rule response data structure required: @@ -61419,31 +48386,6 @@ components: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ - UpdateCaseRequest: - title: Update case request - required: - - id - - patch - type: object - properties: - id: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case to update. Accepts either the case UUID (the `id` - field on a case) or the readable identifier (the `readable_id` - field, e.g. `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - patch: - allOf: - - $ref: '#/components/schemas/CasePatch' - description: Patch payload with fields to update - description: Request to update (patch) a case - externalDocs: - url: '' UpdateCaseResponse: title: Update case response required: @@ -61457,37 +48399,6 @@ components: description: Response containing the updated case externalDocs: url: '' - UpdateCaseSettingsRequest: - title: Update case settings request - required: - - id - type: object - properties: - caseLifecycle: - allOf: - - $ref: '#/components/schemas/CaseLifecycle' - description: Case lifecycle settings to apply - globalIndicatorSettings: - allOf: - - $ref: '#/components/schemas/GlobalIndicatorSettings' - description: New configuration settings to apply - id: - maxLength: 36 - minLength: 36 - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ - type: string - description: ID of the case settings team configuration to update - example: 8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321 - name: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: New display name for the case settings team configuration - example: SRE Case Settings - description: Request to update an existing case settings team configuration. - externalDocs: - url: '' UpdateCaseSettingsResponse: title: Update case settings response required: @@ -61497,42 +48408,8 @@ components: caseSettings: allOf: - $ref: '#/components/schemas/CaseSettings' - description: The updated case settings team configuration - description: Response containing the updated case settings team configuration. - externalDocs: - url: '' - UpdateCommentRequest: - title: Update comment event request - required: - - eventId - - text - type: object - properties: - attachments: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CommentAttachment' - description: Attachments to the comment - eventId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: ID of the comment event to update - example: f56645c5-9cd4-4b9f-961f-4f852d8835a0 - text: - maxLength: 10000 - minLength: 1 - pattern: ^[\s\S]*\S[\s\S]*$ - type: string - description: >- - Comment text to update. Leading and trailing whitespace is trimmed - before the length limits are applied. - example: This is updated text - description: Request for updating a comment on a case event. + description: The updated case settings team configuration + description: Response containing the updated case settings team configuration. externalDocs: url: '' UpdateCommentResponse: @@ -61548,21 +48425,6 @@ components: description: Response returned after successfully updating a comment. externalDocs: url: '' - UpdateContextualDataIntegrationRequest: - title: Update contextual data integration request - type: object - properties: - integrationId: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: ID of the contextual data integration to update. - metadata: - $ref: '#/components/schemas/IntegrationMetadata' - description: Request for updating a contextual data integration. - externalDocs: - url: '' UpdateContextualDataIntegrationResponse: title: Update contextual data integration response type: object @@ -61572,45 +48434,6 @@ components: integration. externalDocs: url: '' - UpdateCustomEnrichmentRequest: - title: Update Custom Enrichment Request - required: - - customEnrichmentId - - name - - description - - file - type: object - properties: - customEnrichmentId: - maximum: 2147483647 - minimum: 0 - type: integer - description: The custom enrichment id. - format: int64 - example: 1 - description: - maxLength: 255 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: New human-readable description of the custom enrichment. - example: custom_enrichment_description - file: - $ref: '#/components/schemas/File' - name: - maxLength: 255 - minLength: 1 - pattern: ^\w+$ - type: string - description: >- - New human-readable name for the custom enrichment. May contain only - letters, digits, and underscores. - example: custom_enrichment_name - description: This request data structure is used to update a custom enrichment - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ UpdateCustomEnrichmentResponse: title: Update Custom Enrichment Response type: object @@ -61631,75 +48454,6 @@ components: description: Find out more about enrichments url: >- https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ - UpdateCustomEvaluationRequest: - type: object - properties: - description: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Human-readable description. - examples: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CustomEvaluationExample' - description: Example conversations and expected scores. - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the custom evaluation to update. - instructions: - maxLength: 1048576 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Instructions sent to the LLM evaluator. - name: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Display name of the custom evaluation. - policyType: - maxLength: 256 - minLength: 1 - pattern: ^[\s\S]+$ - type: string - description: Policy type identifier. - safe: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Description of what counts as safe. - shouldIncludeSystemPrompt: - type: boolean - description: Whether to include the system prompt in the LLM input. - updateMask: - maxLength: 1024 - minLength: 1 - pattern: ^[a-zA-Z_][a-zA-Z0-9_]*(,[a-zA-Z_][a-zA-Z0-9_]*)*$ - type: string - description: >- - Comma-separated list of field paths to update. When provided, only - the listed fields are touched; a listed field that is absent from - the request body is cleared. When omitted, only fields present in - the body are updated. - violates: - maxLength: 65536 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Description of what counts as violating the policy. - description: Request to update a custom evaluation in the catalog. - externalDocs: - url: '' UpdateCustomEvaluationResponse: type: object properties: @@ -61710,81 +48464,6 @@ components: description: Response returned after updating a custom evaluation. externalDocs: url: '' - UpdateDataUsageMetricsExportStatusRequest: - title: Update Data Usage Metrics Export Status Request - type: object - properties: - enabled: - type: boolean - description: Whether this resource is enabled. - example: true - description: This data structure is used to update data usage metrics export status. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - UpdateDataUsageMetricsExportStatusResponse: - title: Update Data Usage Metrics Export Status Response - type: object - properties: - enabled: - type: boolean - description: Whether this resource is enabled. - example: true - description: This data structure is used to return data usage metrics export status. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - UpdateExtensionRequest: - title: Update extension request - type: object - properties: - applications: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The applications. - description: The applications. - extensionDeployment: - allOf: - - $ref: '#/components/schemas/ExtensionDeployment' - description: The extension deployment configuration to update. - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - itemIds: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The item ids. - description: The item ids. - subsystems: - maxItems: 10000 - minItems: 0 - type: array - items: - minLength: 0 - type: string - description: The subsystems. - description: The subsystems. - version: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Version number. - externalDocs: - url: '' UpdateExtensionResponse: title: Update extension response type: object @@ -61794,64 +48473,12 @@ components: description: Response returned after successfully updating a deployed extension. externalDocs: url: '' - UpdateIntegrationRequest: - title: Update integration request - type: object - properties: - id: - maxLength: 65535 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Integration metadata ID generated at creation time. - metadata: - $ref: '#/components/schemas/IntegrationMetadata' - description: This data structure represents a list of outgoing webhook types. - externalDocs: - url: '' UpdateIntegrationResponse: type: object additionalProperties: false description: Response returned after successfully updating an integration. externalDocs: url: '' - UpdateOllyAnalysisSettingsRequest: - type: object - properties: - enabled: - type: boolean - id: - minLength: 0 - type: string - monthlyCapacity: - type: integer - format: int32 - ownershipLabels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/FilterGroup' - priorityFilter: - $ref: '#/components/schemas/CasePriorityFilter' - UpdateOllyAnalysisSettingsResponse: - type: object - properties: - ollyAnalysisSettings: - $ref: '#/components/schemas/OllyAnalysisSettings' - UpdateOutgoingWebhookRequest: - title: Update outgoing webhook request - type: object - properties: - data: - $ref: '#/components/schemas/OutgoingWebhookInputData' - id: - minLength: 0 - type: string - description: Unique identifier. - example: example_id - description: Request for updating an outgoing webhook. - externalDocs: - url: '' UpdateOutgoingWebhookResponse: title: Update outgoing webhook response type: object @@ -61859,94 +48486,6 @@ components: description: Response returned after successfully updating an outgoing webhook. externalDocs: url: '' - UpdatePolicyRequest: - title: Update Policy Request - required: - - id - type: object - oneOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - - type: object - not: - anyOf: - - required: - - logRules - type: object - - required: - - spanRules - type: object - - required: - - rumRules - type: object - properties: - applicationRule: - $ref: '#/components/schemas/quota.v1.Rule' - archiveRetention: - $ref: '#/components/schemas/ArchiveRetention' - description: - maxLength: 255 - minLength: 0 - pattern: ^[\x00-\xFF]*$ - type: string - description: >- - Optional free-text description of the policy's purpose. Only Latin-1 - characters are accepted. - example: My Policy Description - enabled: - type: boolean - description: >- - Indicates whether the policy should be actively evaluated and - applied. - example: true - id: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: Unique identifier of the policy to update. - example: 3dc02998-0b50-4ea8-b68a-4779d716fa1f - logRules: - $ref: '#/components/schemas/LogRules' - name: - maxLength: 255 - minLength: 1 - pattern: ^[\x00-\xFF]*$ - type: string - description: >- - Human-readable name for the policy. Only Latin-1 characters are - accepted. - example: My Policy - priority: - $ref: '#/components/schemas/quota.v1.Priority' - priorityOverride: - $ref: '#/components/schemas/PriorityOverride' - rumRules: - $ref: '#/components/schemas/LogRules' - spanRules: - $ref: '#/components/schemas/SpanRules' - subsystemRule: - $ref: '#/components/schemas/quota.v1.Rule' - targets: - maxItems: 5 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/v1.Target' - description: List of data targets/destinations to which this policy routes data. - description: This data structue is used to update an existing policy. - externalDocs: - description: Find out more about quota management. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ UpdatePolicyResponse: title: Update Policy Response required: @@ -61960,98 +48499,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - UpdateRepositoryRequest: - required: - - repository - type: object - properties: - repository: - allOf: - - $ref: '#/components/schemas/RepositorySetting' - description: >- - The repository setting to update, identified by its repository. - Provide the target classification here. - description: >- - Request to update a single existing repository setting (changes its - classification). The repository is identified by the 'repository' field - in the body (see the RPC-style note on the operation). - externalDocs: - url: '' - UpdateRepositoryResponse: - type: object - properties: - repository: - allOf: - - $ref: '#/components/schemas/RepositorySetting' - description: The updated repository setting. - description: Response containing the updated repository setting. - externalDocs: - url: '' - UpdateRequest: - title: Update Tenant Request - type: object - oneOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - - type: object - not: - anyOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - properties: - gcs: - allOf: - - $ref: '#/components/schemas/GcsConfig' - description: Google Cloud Storage configuration. - ibm: - allOf: - - $ref: '#/components/schemas/IbmConfigV2' - description: IBM Cloud Object Storage configuration. - retentionDays: - minimum: 0 - type: integer - description: Archive retention period in days. - format: int64 - s3: - allOf: - - $ref: '#/components/schemas/S3Config' - description: AWS S3 storage configuration. - description: This data structure is used to update the configuration of a tenant. - externalDocs: - description: Find out more about metrics cost optimization - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ - UpdateRetentionsRequest: - title: Update Retentions Request - required: - - retentionUpdateElements - type: object - properties: - retentionUpdateElements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/RetentionUpdateElement' - description: List of retention tag updates to apply. - description: This data structure is used to update retentions - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ UpdateRetentionsResponse: title: Update Retentions Response required: @@ -62069,42 +48516,12 @@ components: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - UpdateRoleRequest: - type: object - properties: - newDescription: - minLength: 0 - type: string - description: The new description. - newName: - minLength: 0 - type: string - description: The new name. - newPermissions: - $ref: '#/components/schemas/v2.Permissions' - roleId: - minimum: 0 - type: integer - description: The role id. - format: int64 - description: Request for updating a custom role. - externalDocs: - url: '' UpdateRoleResponse: type: object additionalProperties: false description: Response returned after successfully updating a custom role. externalDocs: url: '' - UpdateRuleGroupRequest: - type: object - properties: - groupId: - minLength: 0 - type: string - description: The unique identifier of the parsing rule group to update. - ruleGroup: - $ref: '#/components/schemas/CreateRuleGroupRequest' UpdateRuleGroupResponse: type: object properties: @@ -62113,76 +48530,6 @@ components: description: Response returned after successfully updating a parsing rule group. externalDocs: url: '' - UpdateRuleGroupSet: - title: Update Rule Group Set - required: - - id - type: object - properties: - groups: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/InRuleGroup' - description: List of groups. - id: - maxLength: 128 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Unique identifier. - name: - maxLength: 255 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Display name. - description: A set of rule groups to update. - externalDocs: - description: Find out more about recording rules - url: >- - https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/ - UpdateScopeRequest: - title: Update Scope Request - required: - - id - - displayName - - filters - - defaultExpression - type: object - properties: - defaultExpression: - minLength: 0 - type: string - description: The default expression. - example: true - description: - minLength: 0 - type: string - description: Human-readable description. - example: The best scope - displayName: - minLength: 0 - type: string - description: The display name. - example: my-scope - filters: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/scopes.v1.Filter' - description: List of filters. - id: - minLength: 0 - type: string - description: Unique identifier. - example: 60c82be2-413f-4b8e-8201-7f5c51e2ef2b - description: This data structure represents a request to update a scope - externalDocs: - description: Find out more about scopes - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ UpdateScopeResponse: title: Update Scope Response required: @@ -62196,42 +48543,6 @@ components: description: Find out more about scopes url: >- https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - UpdateTeamGroupRequest: - title: UpdateTeamGroupRequest - type: object - properties: - description: - minLength: 0 - type: string - description: New human-readable description for the team group. - externalId: - minLength: 0 - type: string - description: New external identifier for the group. - groupId: - minimum: 0 - type: integer - description: Unique identifier of the team group to update. - format: int64 - groupType: - $ref: '#/components/schemas/GroupType' - name: - minLength: 0 - type: string - description: New display name for the team group. - roleUpdate: - $ref: '#/components/schemas/RoleUpdate' - scopeUpdate: - $ref: '#/components/schemas/ScopeUpdate' - userUpdates: - $ref: '#/components/schemas/UserUpdates' - description: >- - Request to modify an existing team group's details, including its name, - description, roles, users, and scope settings. - externalDocs: - description: Find out more about groups - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ UpdateTeamGroupResponse: title: UpdateTeamGroupResponse type: object @@ -62243,75 +48554,12 @@ components: description: Find out more about groups url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - UpdateTeamRequest: - type: object - properties: - dailyQuota: - type: number - description: >- - New daily quota for the team, in quota units per day. Omit to keep - the current quota. - format: double - teamId: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Identifier of the team to update. - teamName: - maxLength: 255 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: New display name for the team. Omit to keep the current name. - description: >- - Request to update a team. Omitted optional fields keep their existing - values. - externalDocs: - url: '' UpdateTeamResponse: type: object additionalProperties: false description: Empty response returned after updating a team. externalDocs: url: '' - UpdateUserRequest: - type: object - properties: - userAccountId: - minimum: 0 - type: integer - description: User account ID of the user to update - format: int64 - userTemplate: - allOf: - - $ref: '#/components/schemas/UserTemplate' - description: >- - Template containing updated user properties. Only provided fields - will be updated. - UpdateUsersRequest: - title: UpdateUsersRequest - type: object - properties: - teamId: - minimum: 0 - type: integer - description: Team ID containing the users to update - format: int64 - users: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UpdateUserRequest' - description: >- - List of users to update. Multiple users can be updated in a single - request. - description: >- - Request to update one or more existing users within a team. Allows - modification of user properties including name, status, login modes, and - access type. - externalDocs: - description: Find out more about user management - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ UpdateUsersResponse: title: UpdateUsersResponse type: object @@ -62332,42 +48580,6 @@ components: description: Find out more about user management url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - UpdateUsersStatusesRequest: - title: UpdateUserStatusRequest - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/UserStatus' - description: >- - New status for the users: Active (enables system access) or Inactive - (disables system access) - teamId: - minimum: 0 - type: integer - description: Team ID containing the users to update - format: int64 - userAccountIds: - minItems: 0 - type: array - items: - minimum: 0 - type: integer - description: >- - List of user account IDs to update. All users will be set to the - same status. - format: int64 - description: >- - List of user account IDs to update. All users will be set to the - same status. - description: >- - Request to activate or revoke (deactivate) one or more users within a - team. This operation changes the user status to either Active (enables - access) or Inactive (disables access). - externalDocs: - description: Find out more about user management - url: >- - https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ UpdateUsersStatusesResponse: title: UpdateUserStatusResponse type: object @@ -62392,102 +48604,6 @@ components: description: Find out more about user management url: >- https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/ - UpsertCompanyProvidersInternalRequest: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - providers: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - UpsertCompanyProvidersInternalResponse: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - providers: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - UpsertCompanyProvidersRequest: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - providers: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - UpsertCompanyProvidersResponse: - type: object - properties: - dataSources: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataSource' - providers: - minItems: 0 - type: array - items: - minLength: 0 - type: string - deprecated: true - deprecated: true - UpsertCustomLabelMappingsRequest: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertCustomLabelMappingsResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertGlobalMeasurementsInternalRequest: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - UpsertGlobalMeasurementsInternalResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' UpsertIncidentStatePayload: type: object properties: @@ -62507,62 +48623,6 @@ components: - UPSERT_INCIDENT_STATE_TYPE_RESOLVED type: string description: Upsert incident state type. - UpsertLabelMappingsInternalRequest: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertLabelMappingsInternalResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertLabelMappingsRequest: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertLabelMappingsResponse: - type: object - properties: - mappings: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/LabelMapping' - UpsertMeasurementsInternalRequest: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - UpsertMeasurementsRequest: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' - UpsertMeasurementsResponse: - type: object - properties: - measurements: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Measurement' UrlField: required: - name @@ -62745,36 +48805,6 @@ components: - DAILY_RELATIVE_RANGE_LAST_365_DAYS type: string description: Relative day-oriented presets resolved by the server at request time. - UsageDay: - title: Usage Day - required: - - date - - outputSetStats - - records - type: object - properties: - date: - allOf: - - $ref: '#/components/schemas/Date' - description: Calendar date (UTC). - outputSetStats: - allOf: - - $ref: '#/components/schemas/OutputSetStats' - description: Metadata about the result set for this day. - records: - maxItems: 1000 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/UsageRecord' - description: Usage records for this day. - totals: - allOf: - - $ref: '#/components/schemas/DailyTotals' - description: Daily usage totals. - description: Aggregated usage for a single calendar day. - externalDocs: - url: '' UsageEntry: type: object properties: @@ -62799,72 +48829,6 @@ components: its raw measurements. externalDocs: url: '' - UsageFilter: - title: Usage Filter - type: object - oneOf: - - required: - - sourceIs - type: object - - required: - - priorityIn - type: object - - required: - - serviceNameIs - type: object - - required: - - serviceNameContains - type: object - - required: - - metricNameIs - type: object - - required: - - metricNameContains - type: object - properties: - includeTotals: - type: boolean - description: When true, also narrows daily total aggregates. - metricNameContains: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Substring match on metric name. - metricNameIs: - maxLength: 4096 - minLength: 0 - pattern: ^[\s\S]*$ - type: string - description: Exact metric name match. - priorityIn: - allOf: - - $ref: '#/components/schemas/PriorityList' - description: Match metrics with one of these priorities. - serviceNameContains: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Substring match on service_name. - serviceNameIs: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Exact service_name label match. - sourceIs: - maxLength: 64 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: Match metrics from this source (e.g. apm). - description: >- - A single filter applied to usage records. Exactly one of sourceIs, - priorityIn, serviceNameIs, serviceNameContains, metricNameIs, or - metricNameContains must be set. - externalDocs: - url: '' UsageGroupBy: type: object properties: @@ -63068,81 +49032,6 @@ components: - MEASUREMENT_UNIT_EVENTS type: string description: Raw unit of a measured amount. - UsageRecord: - title: Usage Record - required: - - pillars - - cardinality - - fractionOfDailyCardinality - - bytesVolume - - unitUsage - - fractionOfDailyUsage - type: object - oneOf: - - required: - - service - type: object - - required: - - metric - type: object - - type: object - not: - anyOf: - - required: - - service - type: object - - required: - - metric - type: object - properties: - bytesVolume: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Bytes volume for this record. - cardinality: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Cardinality for this record. - fractionOfDailyCardinality: - maximum: 1 - minimum: 0 - type: number - description: Share of daily cardinality (0 when skip_totals). - format: float - fractionOfDailyUsage: - maximum: 1 - minimum: 0 - type: number - description: Share of daily usage (0 when skip_totals). - format: float - metric: - $ref: '#/components/schemas/MetricRecordExtra' - pillars: - maxItems: 4 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/PillarValue' - description: >- - Values for each requested group-by pillar, in canonical pillar - order. - service: - $ref: '#/components/schemas/ServiceRecordExtra' - unitUsage: - type: number - description: Billable unit usage for this record. - format: float - description: >- - Aggregated usage for one group-by key within a day. Entity-specific - extras (`service` or `metric`) are populated when the resolved entity - type has per-entity attributes; for ENTITY_METRIC and ENTITY_SERVICE - they are always present. Future entity types may omit extras. - externalDocs: - url: '' UsageTier: type: object properties: @@ -63182,14 +49071,6 @@ components: description: Half-open timestamp interval `[start, end)`. Both bounds are required. externalDocs: url: '' - UserAccountId: - type: object - properties: - id: - minimum: 0 - type: integer - description: Unique identifier. - format: int64 UserActor: title: User actor type: object @@ -63205,13 +49086,6 @@ components: description: Information about the user who initiated the action. externalDocs: url: '' - UserId: - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier. UserIdList: type: object properties: @@ -63336,66 +49210,6 @@ components: propertyName: operationType externalDocs: url: '' - ValidateBucketRequest: - title: Bucket Validation Request - type: object - oneOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - - type: object - not: - anyOf: - - required: - - ibm - type: object - - required: - - s3 - type: object - - required: - - gcs - type: object - properties: - gcs: - allOf: - - $ref: '#/components/schemas/GcsConfig' - description: Google Cloud Storage configuration. - ibm: - allOf: - - $ref: '#/components/schemas/IbmConfigV2' - description: IBM Cloud Object Storage configuration. - s3: - allOf: - - $ref: '#/components/schemas/S3Config' - description: AWS S3 storage configuration. - description: This data structure is used to validate a bucket. - externalDocs: - description: Find out more about metrics cost optimization - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/ - ValidateEntityLabelMatcherRequest: - title: Validate Entity Label Matcher Request - type: object - properties: - entityLabelMatcher: - type: object - additionalProperties: - minLength: 0 - type: string - description: >- - Entity label matcher to validate, expressed as a map of label keys - to expected values. - description: Request to validate an entity label matcher - externalDocs: - description: Find out more about notification center - url: >- - https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ ValidateEntityLabelMatcherResponse: title: Validate Entity Label Matcher Response type: object @@ -63453,46 +49267,6 @@ components: description: Test integration result.success. externalDocs: url: '' - ValidateTargetRequest: - title: Set Target Response - required: - - isActive - type: object - oneOf: - - required: - - s3 - type: object - - required: - - ibmCos - type: object - properties: - ibmCos: - $ref: '#/components/schemas/IBMCosTargetSpec' - isActive: - type: boolean - s3: - $ref: '#/components/schemas/S3TargetSpec' - description: This data structure is used to validate a storage target for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - ValidateTargetResponse: - title: Validate Target Response - required: - - isValid - type: object - properties: - isValid: - type: boolean - example: true - description: >- - This data structure is obtained after validating a storage target for - logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ Value: enum: - VALUE_DEBUG_OR_UNSPECIFIED @@ -64680,11 +50454,6 @@ components: description: Weekly recurrence. externalDocs: url: '' - WideParquet: - type: object - properties: - version: - $ref: '#/components/schemas/wide_parquet.v1.Version' Widget: title: Widget type: object @@ -64894,29 +50663,6 @@ components: description: Definition of a window-based SLI based on metrics externalDocs: url: '' - WindowBasedPermutationData: - type: object - properties: - badWindows: - minimum: 0 - type: integer - format: int64 - deprecated: true - badWindowsV2: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - goodWindows: - minimum: 0 - type: integer - format: int64 - deprecated: true - goodWindowsV2: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string WindowSloWindow: enum: - WINDOW_SLO_WINDOW_UNSPECIFIED @@ -64924,65 +50670,6 @@ components: - WINDOW_SLO_WINDOW_5_MINUTES type: string description: Window slo window. - WithdrawAiCenterCodeAgentsRequest: - required: - - pairs - type: object - properties: - pairs: - maxItems: 100 - minItems: 1 - type: array - items: - $ref: '#/components/schemas/WithdrawCodeAgentPair' - description: >- - The product and integration type pairs to withdraw. Duplicate pairs - are accepted and collapsed; pairs that were never marked are - ignored. - description: >- - Request to withdraw one or more product and integration type pairs. Team - is resolved from auth context. Idempotent: pairs that are not marked - succeed unchanged. - externalDocs: - url: '' - WithdrawAiCenterCodeAgentsResponse: - type: object - properties: - codeAgents: - maxItems: 50 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/CodeAgentIntegration' - description: >- - The full, remaining list of code agents marked as successfully - integrated. Empty when the last pair was withdrawn. - description: >- - Response containing the full, remaining list of code agents marked as - successfully integrated, each with its marked integration types. - externalDocs: - url: '' - WithdrawCodeAgentPair: - required: - - product - - integrationType - type: object - properties: - integrationType: - allOf: - - $ref: '#/components/schemas/CodeAgentIntegrationType' - description: >- - Which of this product's integration types to withdraw. - CODE_AGENT_INTEGRATION_TYPE_UNSPECIFIED is rejected with HTTP 400. - product: - allOf: - - $ref: '#/components/schemas/AiCenterProduct' - description: >- - The AI product to withdraw. AI_CENTER_PRODUCT_UNSPECIFIED is - rejected with HTTP 400. - description: A single product and integration type pair to withdraw. - externalDocs: - url: '' XAxis: type: object oneOf: @@ -65117,57 +50804,6 @@ components: - FILTER_MATCHER_NOT_EQUALS - FILTER_MATCHER_CONTAINS type: string - alerts.v3.OrderBy: - title: Order by - type: object - properties: - direction: - allOf: - - $ref: '#/components/schemas/alerts.v3.OrderByDirection' - description: Direction for ordering - example: ORDER_BY_DIRECTION_ASC_OR_UNSPECIFIED - fieldName: - allOf: - - $ref: '#/components/schemas/alerts.v3.OrderByFields' - description: Field name to order by - example: ORDER_BY_FIELDS_UPDATED_TIME - description: >- - A data structure that specifies the field and direction for ordering - query results - externalDocs: - url: '' - alerts.v3.OrderByDirection: - enum: - - ORDER_BY_DIRECTION_ASC_OR_UNSPECIFIED - - ORDER_BY_DIRECTION_DESC - type: string - description: Events.v3.order by direction. - alerts.v3.OrderByFields: - enum: - - ORDER_BY_FIELDS_UNSPECIFIED - - ORDER_BY_FIELDS_NAME - - ORDER_BY_FIELDS_ID - - ORDER_BY_FIELDS_SEVERITY - - ORDER_BY_FIELDS_CREATED_TIME - - ORDER_BY_FIELDS_UPDATED_TIME - - ORDER_BY_FIELDS_LAST_TRIGGERED - type: string - description: Order by fields. - alerts.v3.PaginationRequest: - type: object - properties: - pageSize: - maximum: 1000 - minimum: 0 - type: integer - description: Page size. - format: int64 - pageToken: - maxLength: 4096 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The page token. alerts.v3.PaginationResponse: type: object properties: @@ -65210,17 +50846,6 @@ components: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - cases.v1.GetFilterValuesRequest: - title: Get case filter values request - type: object - properties: - filters: - allOf: - - $ref: '#/components/schemas/CaseFilters' - description: Filters to apply when computing available values - description: Request to retrieve available filter and aggregation values for cases. - externalDocs: - url: '' cases.v1.GetFilterValuesResponse: title: Get case filter values response required: @@ -65351,53 +50976,6 @@ components: description: Minimal user identity information used in case assignments. externalDocs: url: '' - common.Action: - title: Action - type: object - properties: - dashboardId: - minLength: 0 - type: string - description: >- - Reference to specific dashboard, can be null if the action is team - wide - dataSource: - allOf: - - $ref: '#/components/schemas/ActionDataSourceType' - description: Defines the data source type of the action, if applicable - definition: - allOf: - - $ref: '#/components/schemas/ActionDefinition' - description: Definition of the action - id: - minLength: 0 - type: string - description: A unique identifier of the action - isPrivate: - type: boolean - description: Defines if the action is private to the user or shared with the team - name: - minLength: 0 - type: string - description: The display name of the action - shouldOpenInNewWindow: - type: boolean - description: >- - Defines if the action should open in a new window or current window - in the browser - widgetId: - minLength: 0 - type: string - description: >- - Reference to specific widget within a dashboard, can be null if the - action is team wide or dashboard wide - description: >- - Actions are user-defined actions that can be triggered from the - dashboard over specific widget. - externalDocs: - description: Learn more about Custom Dashboards in our documentation. - url: >- - https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ common.Aggregation: enum: - AGGREGATION_UNSPECIFIED @@ -65420,19 +50998,6 @@ components: description: Line chart.dataprime query. externalDocs: url: '' - common.Group: - type: object - properties: - field: - $ref: '#/components/schemas/FieldGroup' - groups: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/common.Group' - value: - type: number - format: double common.Threshold: title: Threshold type: object @@ -65463,24 +51028,6 @@ components: - THRESHOLD_BY_BACKGROUND type: string description: Threshold by. - common.TimeSeries: - type: object - properties: - labels: - type: object - additionalProperties: - minLength: 0 - type: string - description: Labels. - name: - minLength: 0 - type: string - description: Display name. - values: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/DataPoint' common.Unit: enum: - UNIT_UNSPECIFIED @@ -65507,73 +51054,11 @@ components: - UNIT_DATETIME_ISO type: string description: Unit. - csv.v1.Version: - enum: - - VERSION_UNSPECIFIED - - VERSION_V1 - type: string - datausage.v1.Priority: - enum: - - PRIORITY_UNSPECIFIED - - PRIORITY_LOW - - PRIORITY_MEDIUM - - PRIORITY_HIGH - - PRIORITY_BLOCKED - type: string - datausage.v1.Retention: - type: object - properties: - value: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: The value. - datausage.v1.Severity: - enum: - - SEVERITY_UNSPECIFIED - - SEVERITY_DEBUG - - SEVERITY_VERBOSE - - SEVERITY_INFO - - SEVERITY_WARNING - - SEVERITY_ERROR - - SEVERITY_CRITICAL - type: string - datausage.v2.Severity: - enum: - - SEVERITY_UNSPECIFIED - - SEVERITY_DEBUG - - SEVERITY_VERBOSE - - SEVERITY_INFO - - SEVERITY_WARNING - - SEVERITY_ERROR - - SEVERITY_CRITICAL - type: string - description: Severity. - datausage.v2.Team: - type: object - properties: - id: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string events.v3.FilterMatcher: enum: - FILTER_MATCHER_TEXT_OR_UNSPECIFIED - FILTER_MATCHER_REGEXP type: string - events.v3.OrderBy: - type: object - properties: - direction: - allOf: - - $ref: '#/components/schemas/events.v3.OrderByDirection' - example: ORDER_BY_DIRECTION_ASC - fieldName: - allOf: - - $ref: '#/components/schemas/events.v3.OrderByFields' - example: ORDER_BY_FIELDS_TIMESTAMP events.v3.OrderByDirection: enum: - ORDER_BY_DIRECTION_UNSPECIFIED @@ -65587,20 +51072,6 @@ components: - ORDER_BY_FIELDS_TIMESTAMP type: string description: Order by fields. - events.v3.PaginationRequest: - type: object - properties: - pageSize: - minimum: 0 - type: integer - description: Maximum number of results to return per page. - format: int64 - example: 10 - pageToken: - minLength: 0 - type: string - description: Opaque token for fetching the next page of results. - example: test events.v3.PaginationResponse: type: object properties: @@ -65657,22 +51128,6 @@ components: exploring our documentation. url: >- https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ - generic.v1.Version: - enum: - - VERSION_UNSPECIFIED - - VERSION_V1 - type: string - incidents.v1.GetFilterValuesRequest: - title: Get filter values request - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/IncidentQueryFilter' - description: Filter for incidents - description: Request to get available filter values for incidents - externalDocs: - url: '' incidents.v1.GetFilterValuesResponse: title: Get filter values response required: @@ -65796,85 +51251,6 @@ components: description: Meta label. externalDocs: url: '' - metric_explore.TimeSeries: - type: object - properties: - labels: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Label' - samples: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/Sample' - metric_schema.Filter: - type: object - oneOf: - - required: - - substring - type: object - - required: - - regex - type: object - - type: object - not: - anyOf: - - required: - - substring - type: object - - required: - - regex - type: object - properties: - caseSensitive: - type: boolean - regex: - minLength: 0 - type: string - substring: - minLength: 0 - type: string - metric_usage_service.EntityType: - enum: - - ENTITY_METRIC - - ENTITY_SERVICE - type: string - description: Whether usage is aggregated per metric or per service. - metric_usage_service.OrderBy: - enum: - - USAGE - - CARDINALITY - - SAMPLE_COUNT - type: string - description: Field to sort daily usage records by. - metric_usage_service.Ordering: - enum: - - DESCENDING - - ASCENDING - type: string - description: Sort direction for ordered results. - metrics.Priority: - title: Metric priority - enum: - - HIGH - - MEDIUM - - LOW - - BLOCKED - type: string - description: Ingestion priority tier assigned to a metric. - example: HIGH - metrics_blocking_rules.Rule: - type: object - properties: - ruleExpression: - $ref: '#/components/schemas/RuleExpression' - ruleId: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string notification_center.ConditionType: type: object oneOf: @@ -65928,6 +51304,7 @@ components: - PAGERDUTY_INCIDENTS - MICROSOFT_TEAMS - EVENTBRIDGE + - INCIDENT_IO type: string description: Connector type. notification_center.EntityType: @@ -65964,60 +51341,6 @@ components: description: Find out more about notification center url: >- https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/ - organisations.v2.Team: - type: object - properties: - clusterId: - minLength: 0 - type: string - id: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Unique identifier. - isAuditingTeam: - type: boolean - name: - minLength: 0 - type: string - description: Display name. - planType: - $ref: '#/components/schemas/PlanType' - quota: - type: number - format: float - retention: - type: integer - format: int32 - organisations.v2.User: - type: object - properties: - firstName: - minLength: 0 - type: string - lastName: - minLength: 0 - type: string - userAccountId: - $ref: '#/components/schemas/UserAccountId' - username: - minLength: 0 - type: string - query_usages.OrderBy: - enum: - - EXECUTION_COUNT - - LAST_RUN - - ERROR_RATE - type: string - query_usages.Ordering: - enum: - - DESCENDING - - ASCENDING - type: string - query_usages.QueryType: - enum: - - INSTANT - - RANGE - type: string quota.v1.Priority: enum: - PRIORITY_TYPE_UNSPECIFIED @@ -66089,32 +51412,6 @@ components: associated with it externalDocs: url: '' - routing.SourceOverrides: - type: object - properties: - connectorConfigFields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/TemplatedConnectorConfigField' - description: The connector config fields. - messageConfigFields: - maxItems: 100 - minItems: 0 - type: array - items: - $ref: '#/components/schemas/notification_center.MessageConfigField' - description: The message config fields. - payloadType: - maxLength: 100 - minLength: 1 - pattern: ^[\s\S]*$ - type: string - description: The payload type. - description: Source overrides. - externalDocs: - url: '' rules.v1.Rule: type: object properties: @@ -66160,18 +51457,6 @@ components: description: Find out more about scopes url: >- https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - v1.AutoRetireTimeframe: - enum: - - AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED - - AUTO_RETIRE_TIMEFRAME_MINUTES_5 - - AUTO_RETIRE_TIMEFRAME_MINUTES_10 - - AUTO_RETIRE_TIMEFRAME_HOUR_1 - - AUTO_RETIRE_TIMEFRAME_HOURS_2 - - AUTO_RETIRE_TIMEFRAME_HOURS_6 - - AUTO_RETIRE_TIMEFRAME_HOURS_12 - - AUTO_RETIRE_TIMEFRAME_HOURS_24 - type: string - description: Auto retire timeframe. v1.ConnectorType: enum: - CONNECTOR_TYPE_UNSPECIFIED @@ -66183,19 +51468,6 @@ components: - CONNECTOR_TYPE_MICROSOFT_TEAMS type: string description: Connector type. - v1.DateRange: - type: object - properties: - fromDate: - minLength: 0 - type: string - description: The from date. - format: date-time - toDate: - minLength: 0 - type: string - description: The to date. - format: date-time v1.Duration: type: object properties: @@ -66309,32 +51581,6 @@ components: - FILTER_OPERATOR_AND type: string description: Filter operator. - v1.GB: - type: object - properties: - value: - type: number - description: The value. - format: float - description: Gb. - externalDocs: - url: '' - v1.GetEventRequest: - title: Get event request - required: - - eventId - type: object - properties: - eventId: - maxLength: 36 - minLength: 36 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: ID of the event to fetch - example: f56645c5-9cd4-4b9f-961f-4f852d8835a0 - externalDocs: - url: '' v1.GetEventResponse: title: Get event response required: @@ -66456,34 +51702,6 @@ components: in cases. externalDocs: url: '' - v1.LabelValue: - type: object - properties: - label: - minLength: 0 - type: string - value: - minLength: 0 - type: string - v1.ListEventsRequest: - title: List events request - required: - - caseId - type: object - properties: - caseId: - maxLength: 64 - minLength: 1 - pattern: >- - ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[A-Z]+-[0-9]+)$ - type: string - description: >- - ID of the case. Accepts either the case UUID (the `id` field on a - case) or the readable identifier (the `readable_id` field, e.g. - `CASE-123`). - example: 3f166e9f-3c88-4af2-b52e-138f339dab3e - externalDocs: - url: '' v1.ListEventsResponse: title: List events response required: @@ -66531,43 +51749,6 @@ components: - ORDER_BY_DIRECTION_DESC type: string description: Order by direction. - v1.OrderByFields: - enum: - - ORDER_BY_FIELDS_UNSPECIFIED - - ORDER_BY_FIELDS_ID - - ORDER_BY_FIELDS_SEVERITY - - ORDER_BY_FIELDS_NAME - - ORDER_BY_FIELDS_CREATED_TIME - - ORDER_BY_FIELDS_CLOSED_TIME - type: string - description: Order by fields. - v1.QueryType: - enum: - - QUERY_TYPE_UNSPECIFIED - - QUERY_TYPE_RANGE - - QUERY_TYPE_INSTANT - type: string - v1.Range: - enum: - - RANGE_UNSPECIFIED - - RANGE_CURRENT_MONTH - - RANGE_LAST_30_DAYS - - RANGE_LAST_90_DAYS - - RANGE_LAST_WEEK - - RANGE_LAST_YEAR - type: string - description: Range. - v1.Resolution: - enum: - - RESOLUTION_UNSPECIFIED - - RESOLUTION_ONE_MINUTE - - RESOLUTION_FIVE_MINUTES - - RESOLUTION_FIFTEEN_MINUTES - - RESOLUTION_ONE_HOUR - - RESOLUTION_SIX_HOURS - - RESOLUTION_ONE_DAY - - RESOLUTION_ONE_WEEK - type: string v1.Revision: title: Revision type: object @@ -66638,17 +51819,6 @@ components: description: Find out more about scopes url: >- https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - v1.SloDefinition: - type: object - properties: - sloId: - minLength: 0 - type: string - v1.SortOrder: - enum: - - SORT_ORDER_DESCENDING_OR_UNSPECIFIED - - SORT_ORDER_ASCENDING - type: string v1.SourceType: enum: - SOURCE_TYPE_UNSPECIFIED @@ -66657,19 +51827,6 @@ components: - SOURCE_TYPE_RUM type: string description: Source type. - v1.Span: - type: object - properties: - processTags: - type: object - additionalProperties: - minLength: 0 - type: string - tags: - type: object - additionalProperties: - minLength: 0 - type: string v1.Target: title: Target type: object @@ -66709,24 +51866,6 @@ components: description: Find out more about quota management. url: >- https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/ - v1.TcoTier: - enum: - - TCO_TIER_UNSPECIFIED - - TCO_TIER_LOW - - TCO_TIER_MEDIUM - - TCO_TIER_HIGH - - TCO_TIER_BLOCKED - type: string - description: Tco tier. - v1.Team: - type: object - properties: - id: - maxLength: 20 - minLength: 1 - pattern: ^[0-9]+$ - type: string - description: Unique identifier. v1.TeamId: type: object properties: @@ -66758,23 +51897,6 @@ components: description: Represents a time range with start and end timestamps externalDocs: url: '' - v1.UndetectedValuesManagement: - type: object - properties: - autoRetireTimeframe: - $ref: '#/components/schemas/v1.AutoRetireTimeframe' - triggerUndetectedValues: - type: boolean - v1.Unit: - type: object - properties: - value: - type: number - description: The value. - format: float - description: Gauge.unit. - externalDocs: - url: '' v1.common.DataModeType: enum: - DATA_MODE_TYPE_HIGH_UNSPECIFIED @@ -66784,51 +51906,6 @@ components: Data mode type. Omitted or DATA_MODE_TYPE_HIGH_UNSPECIFIED queries high-priority ('Frequent Search') data; DATA_MODE_TYPE_ARCHIVE queries archive ('Monitoring') data. - v1alpha.EntityType: - enum: - - ENTITY_TYPE_UNSPECIFIED - - ENTITY_TYPE_LOGS - - ENTITY_TYPE_BULK_SIZES - - ENTITY_TYPE_BROWSER_LOGS - - ENTITY_TYPE_ALERTS - - ENTITY_TYPE_ALERT_DEFS - - ENTITY_TYPE_AUDIT_EVENTS - - ENTITY_TYPE_DASHBOARDS - - ENTITY_TYPE_ENRICHMENT_RULES - - ENTITY_TYPE_MOBILE_LOGS - - ENTITY_TYPE_NOTIFICATION_DELIVERIES - - ENTITY_TYPE_SCHEMA_FIELDS - - ENTITY_TYPE_TEXT - - ENTITY_TYPE_BROWSER_EVENTS - - ENTITY_TYPE_AI_EVALUATIONS - - ENTITY_TYPE_ENGINE_QUERIES - - ENTITY_TYPE_ENGINE_SCHEMA_FIELDS - - ENTITY_TYPE_NOTIFICATION_REQUESTS - - ENTITY_TYPE_INFRA_MONITORING_EVENTS - - ENTITY_TYPE_LABS_LIMIT_VIOLATIONS - - ENTITY_TYPE_QUOTA_EVENTS - - ENTITY_TYPE_METRICS - - ENTITY_TYPE_SPANS - - ENTITY_TYPE_SESSION_RECORDINGS - - ENTITY_TYPE_DSYM - - ENTITY_TYPE_FILES - - ENTITY_TYPE_MOBILE_SNAPSHOTS - - ENTITY_TYPE_PROGUARD - - ENTITY_TYPE_SOURCE_MAPS - - ENTITY_TYPE_SESSION_SNAPSHOTS - - ENTITY_TYPE_CPU_PROFILES - - ENTITY_TYPE_EVENTS - type: string - v1alpha.Pillar: - enum: - - PILLAR_UNSPECIFIED - - PILLAR_LOGS - - PILLAR_METRICS - - PILLAR_SPANS - - PILLAR_BINARY - - PILLAR_PROFILES - - PILLAR_EVENTS - type: string v2.Action: type: object properties: @@ -66967,37 +52044,6 @@ components: description: Find out more about events2metrics url: >- https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/ - v2.DateRange: - title: Date Range - type: object - properties: - fromDate: - minLength: 0 - type: string - description: The from date. - format: date-time - example: '2021-01-01T00:00:00.000Z' - toDate: - minLength: 0 - type: string - description: The to date. - format: date-time - example: '2021-01-01T00:00:00.000Z' - description: This data structure represents a date range. - externalDocs: - description: Find out more about data usage. - url: >- - https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/ - v2.GB: - type: object - properties: - value: - type: number - description: Numeric value representing the amount in gigabytes. - format: float - description: A quantity expressed in gigabytes. - externalDocs: - url: '' v2.LogsQuery: title: SpansQuery type: object @@ -67100,35 +52146,6 @@ components: description: Permissions. externalDocs: url: '' - v2.Pillar: - enum: - - PILLAR_UNSPECIFIED - - PILLAR_METRICS - - PILLAR_LOGS - - PILLAR_SPANS - - PILLAR_BINARY - - PILLAR_PROFILES - type: string - description: Pillar. - v2.Priority: - enum: - - PRIORITY_UNSPECIFIED - - PRIORITY_LOW - - PRIORITY_MEDIUM - - PRIORITY_HIGH - - PRIORITY_BLOCKED - type: string - description: Priority. - v2.Range: - enum: - - RANGE_UNSPECIFIED - - RANGE_CURRENT_MONTH - - RANGE_LAST_30_DAYS - - RANGE_LAST_90_DAYS - - RANGE_LAST_WEEK - - RANGE_LAST_YEAR - type: string - description: Time range for data usage queries. v2.Scope: title: Scope type: object @@ -67144,25 +52161,6 @@ components: description: Find out more about scopes url: >- https://coralogix.com/docs/user-guides/account-management/user-management/scopes/ - v2.SetActiveRequest: - title: Set Active Request - type: object - properties: - isActive: - type: boolean - description: The is active. - teamId: - minimum: 0 - type: integer - description: Team identifier. - format: int64 - description: >- - This data structure is used to activate or deactivate a SAML identity - provider - externalDocs: - description: Find out more about enrichments - url: >- - https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/ v2.SetActiveResponse: type: object additionalProperties: false @@ -67264,15 +52262,6 @@ components: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - v2.TcoTier: - enum: - - TCO_TIER_UNSPECIFIED - - TCO_TIER_LOW - - TCO_TIER_MEDIUM - - TCO_TIER_HIGH - - TCO_TIER_BLOCKED - type: string - description: Deprecated TCO tier classification. v2.TeamId: type: object properties: @@ -67285,28 +52274,6 @@ components: description: Team id. externalDocs: url: '' - v2.TeamInfo: - type: object - properties: - id: - allOf: - - $ref: '#/components/schemas/v2.TeamId' - description: Unique identifier. - organisationId: - $ref: '#/components/schemas/OrganisationId' - organisationName: - minLength: 0 - type: string - v2.Unit: - type: object - properties: - value: - type: number - description: Numeric value representing the amount in units. - format: float - description: A quantity expressed in units of data consumption. - externalDocs: - url: '' v3.ApiKey: title: API Key type: object @@ -67366,67 +52333,15 @@ components: minLength: 0 type: string description: The template for the configuration field - example: template_example - externalDocs: - url: '' - v3.EventMetricMoreThanUsual: - type: object - properties: - dynamicAlertMatch: - $ref: '#/components/schemas/DynamicAlertMatch' - v3.EventMetricMoreThanUsualEnriched: - type: object - properties: - eventMetricMoreThanUsual: - $ref: '#/components/schemas/v3.EventMetricMoreThanUsual' - prediction: - $ref: '#/components/schemas/v3.Prediction' - v3.EventStandardMoreThanUsual: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - hitValue: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - toTimestamp: - minLength: 0 - type: string - format: date-time - v3.FilterOperator: - enum: - - FILTER_OPERATOR_AND_OR_UNSPECIFIED - - FILTER_OPERATOR_OR - type: string - description: Filter operator. - v3.GetEventRequest: - title: GetEventRequest - required: - - id - type: object - properties: - id: - minLength: 0 - type: string - description: Unique identifier of the alert event to retrieve. - example: test - orderBys: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/events.v3.OrderBy' - description: The order bys. - pagination: - allOf: - - $ref: '#/components/schemas/events.v3.PaginationRequest' - description: Pagination parameters for the response. - description: This data structure represents a request to get an event + example: template_example externalDocs: url: '' + v3.FilterOperator: + enum: + - FILTER_OPERATOR_AND_OR_UNSPECIFIED + - FILTER_OPERATOR_OR + type: string + description: Filter operator. v3.GetEventResponse: type: object properties: @@ -67437,126 +52352,6 @@ components: description: Response containing the details of an alert event. externalDocs: url: '' - v3.Group: - title: Alert notification group - type: object - oneOf: - - required: - - logsImmediate - type: object - - required: - - logsThreshold - type: object - - required: - - metricThreshold - type: object - - required: - - sloBurnRateThreshold - type: object - - required: - - sloErrorBudgetThreshold - type: object - - required: - - flow - type: object - - required: - - newValue - type: object - - required: - - ratioThreshold - type: object - - required: - - timeRelativeThreshold - type: object - - required: - - tracingImmediate - type: object - - required: - - tracingThreshold - type: object - - required: - - uniqueCount - type: object - - type: object - not: - anyOf: - - required: - - logsImmediate - type: object - - required: - - logsThreshold - type: object - - required: - - metricThreshold - type: object - - required: - - sloBurnRateThreshold - type: object - - required: - - sloErrorBudgetThreshold - type: object - - required: - - flow - type: object - - required: - - newValue - type: object - - required: - - ratioThreshold - type: object - - required: - - timeRelativeThreshold - type: object - - required: - - tracingImmediate - type: object - - required: - - tracingThreshold - type: object - - required: - - uniqueCount - type: object - properties: - flow: - $ref: '#/components/schemas/FlowNotification' - isNoData: - type: boolean - keyValues: - type: object - additionalProperties: - minLength: 0 - type: string - logsImmediate: - $ref: '#/components/schemas/LogsImmediateNotification' - logsThreshold: - $ref: '#/components/schemas/LogsThresholdNotification' - metricThreshold: - $ref: '#/components/schemas/MetricThresholdNotification' - newValue: - $ref: '#/components/schemas/NewValueNotification' - priority: - $ref: '#/components/schemas/AlertDefPriority' - ratioThreshold: - $ref: '#/components/schemas/RatioThresholdNotification' - sloBurnRateThreshold: - $ref: '#/components/schemas/SloBurnRateThresholdNotification' - sloErrorBudgetThreshold: - $ref: '#/components/schemas/SloErrorBudgetThresholdNotification' - status: - $ref: '#/components/schemas/AlertStatus' - suppressed: - type: boolean - timeRelativeThreshold: - $ref: '#/components/schemas/TimeRelativeThresholdNotification' - tracingImmediate: - $ref: '#/components/schemas/TracingImmediateNotification' - tracingThreshold: - $ref: '#/components/schemas/TracingThresholdNotification' - uniqueCount: - $ref: '#/components/schemas/UniqueCountNotification' - description: A group of related alerts with the same status - externalDocs: - url: '' v3.IntegrationType: title: Integration type type: object @@ -67590,30 +52385,6 @@ components: description: Defines the type of integration to use for notifications externalDocs: url: '' - v3.ListEventsRequest: - title: ListEventsRequest - required: - - filter - - pagination - type: object - properties: - filter: - allOf: - - $ref: '#/components/schemas/EventsFilter' - description: Filter criteria for events. - orderBys: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/events.v3.OrderBy' - description: Ordering criteria for the returned events. - pagination: - allOf: - - $ref: '#/components/schemas/events.v3.PaginationRequest' - description: Pagination parameters for the response. - description: This data structure represents a request to list events - externalDocs: - url: '' v3.ListEventsResponse: title: ListEventsResponse required: @@ -67671,97 +52442,6 @@ components: description: Labels for the permutation. externalDocs: url: '' - v3.Prediction: - type: object - properties: - predictionTimestampMap: - type: object - additionalProperties: - $ref: '#/components/schemas/v3.PredictionProperties' - v3.Prediction.PredictionTimestampMapEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/v3.PredictionProperties' - v3.PredictionProperties: - type: object - properties: - lowerLimit: - type: number - format: double - upperLimit: - type: number - format: double - v3.Priority: - title: Alert definition priority - type: object - properties: - name: - minLength: 0 - type: string - description: String representation of the priority - value: - allOf: - - $ref: '#/components/schemas/AlertDefPriority' - description: The priority of the alert definition - example: ALERT_DEF_PRIORITY_P3 - description: Defines the priority of an alert definition - externalDocs: - url: '' - v3.SearchDetails: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - interval: - $ref: '#/components/schemas/v3.SearchDetailsInterval' - toTimestamp: - minLength: 0 - type: string - format: date-time - v3.SearchDetailsInterval: - type: object - properties: - durationMs: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - name: - minLength: 0 - type: string - description: Display name. - v3.SetActiveRequest: - title: Enable/disable alert request - type: object - properties: - active: - type: boolean - description: Whether to enable or disable the alert definition - example: true - id: - maxLength: 36 - minLength: 0 - pattern: >- - ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ - type: string - description: The alert definition ID - example: 123e4567-e89b-12d3-a456-426614174000 - description: A request to enable or disable an alert - externalDocs: - url: '' - v3.SetActiveResponse: - title: Set active response - type: object - additionalProperties: false - description: Response after enabling or disabling an alert definition - externalDocs: - url: '' v3.SloDefinition: title: SLO Definition type: object @@ -67801,16 +52481,6 @@ components: description: Source overrides. externalDocs: url: '' - v3.Span: - type: object - properties: - startTime: - minLength: 0 - type: string - format: date-time - traceId: - minLength: 0 - type: string v3.TimeRange: title: Time range type: object @@ -67850,167 +52520,6 @@ components: description: Configuration for handling undetected values in alerts externalDocs: url: '' - v4.EventMetricLessThanUsual: - type: object - properties: - lessThanUsual: - $ref: '#/components/schemas/EventUnusualPayload' - v4.EventMetricLessThanUsualEnriched: - type: object - properties: - eventMetricLessThanUsual: - $ref: '#/components/schemas/v4.EventMetricLessThanUsual' - prediction: - $ref: '#/components/schemas/v4.Prediction' - v4.EventMetricMoreThanUsual: - type: object - properties: - moreThanUsual: - $ref: '#/components/schemas/EventUnusualPayload' - v4.EventMetricMoreThanUsualEnriched: - type: object - properties: - eventMetricMoreThanUsual: - $ref: '#/components/schemas/v4.EventMetricMoreThanUsual' - prediction: - $ref: '#/components/schemas/v4.Prediction' - v4.ExtremeSample: - type: object - properties: - lowerLimit: - type: number - format: double - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - upperLimit: - type: number - format: double - value: - type: number - format: double - v4.Prediction: - type: object - properties: - predictionTimestampMap: - type: object - additionalProperties: - $ref: '#/components/schemas/v4.PredictionProperties' - v4.Prediction.PredictionTimestampMapEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/v4.PredictionProperties' - v4.PredictionProperties: - type: object - properties: - lowerLimit: - type: number - format: double - upperLimit: - type: number - format: double - v4.SearchDetails: - type: object - properties: - fromTimestamp: - minLength: 0 - type: string - format: date-time - interval: - $ref: '#/components/schemas/v4.SearchDetailsInterval' - toTimestamp: - minLength: 0 - type: string - format: date-time - v4.SearchDetailsInterval: - type: object - properties: - durationMs: - maxLength: 20 - minLength: 1 - pattern: ^-?[0-9]+$ - type: string - name: - minLength: 0 - type: string - description: Display name. - v5.EventMetricLessThanUsual: - type: object - properties: - lessThanUsual: - $ref: '#/components/schemas/EventMetricUnusualPayload' - v5.EventMetricLessThanUsualEnriched: - type: object - properties: - eventMetricLessThanUsual: - $ref: '#/components/schemas/v5.EventMetricLessThanUsual' - prediction: - $ref: '#/components/schemas/v5.Prediction' - v5.EventMetricMoreThanUsual: - type: object - properties: - moreThanUsual: - $ref: '#/components/schemas/EventMetricUnusualPayload' - v5.EventMetricMoreThanUsualEnriched: - type: object - properties: - eventMetricMoreThanUsual: - $ref: '#/components/schemas/v5.EventMetricMoreThanUsual' - prediction: - $ref: '#/components/schemas/v5.Prediction' - v5.EventStandardMoreThanUsual: - type: object - properties: - moreThanUsual: - $ref: '#/components/schemas/EventStandardUnusualPayload' - v5.ExtremeSample: - type: object - properties: - lowerLimit: - type: number - format: double - timestamp: - minLength: 0 - type: string - description: Timestamp. - format: date-time - upperLimit: - type: number - format: double - value: - type: number - description: The value. - format: double - v5.Prediction: - type: object - properties: - predictionTimestampMap: - type: object - additionalProperties: - $ref: '#/components/schemas/v5.PredictionProperties' - v5.Prediction.PredictionTimestampMapEntry: - type: object - properties: - key: - minLength: 0 - type: string - value: - $ref: '#/components/schemas/v5.PredictionProperties' - v5.PredictionProperties: - type: object - properties: - lowerLimit: - type: number - format: double - upperLimit: - type: number - format: double views.v1.Filter: title: ViewFolder required: @@ -68033,12 +52542,6 @@ components: description: View folder. externalDocs: url: '' - wide_parquet.v1.Version: - enum: - - VERSION_UNSPECIFIED - - VERSION_V1 - - VERSION_V3 - type: string widgets.BarValueDisplay: enum: - BAR_VALUE_DISPLAY_UNSPECIFIED @@ -68324,248 +52827,6 @@ components: in: header name: Authorization description: API key authentication -tags: - - name: AI Applications Service - description: Manage the catalog of AI applications discovered from spans. - externalDocs: - url: '' - - name: AI Evaluations Service - description: >- - Manage AI evaluations and the custom evaluation catalog for AI - applications. - externalDocs: - url: '' - - name: API Keys Admin Service - description: Administrative operations for API Keys management. - externalDocs: - url: '' - - name: API Keys Service - description: Manage your API Keys. - externalDocs: - url: '' - - name: Actions Service - description: View and manage your Actions. - externalDocs: - url: '' - - name: Alert Scheduler Rule service - description: Manage your alert scheduler rules. - externalDocs: - url: '' - - name: Alert definitions service - description: >- - View and manage your alerts using alert definitions - data structures that - contain the configuration required to create an alert. - externalDocs: - description: Learn more about alerts in our documentation - url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - - name: Alert events service - description: >- - Get information regarding your alert events - instances of alerts being - triggered. - externalDocs: - description: Learn more about alert events and incidents in our documentation. - url: https://coralogix.com/docs/user-guides/alerting/incidents/ - - name: Case Events service - description: Manage case events, comments, and external thread synchronization. - externalDocs: - url: '' - - name: Case Settings service - description: Manage case settings team configurations. - externalDocs: - url: '' - - name: Cases notification service - description: Track notification adjacent data for cases. - externalDocs: - url: '' - - name: Cases service - description: >- - Manage cases throughout their lifecycle. Create, view, assign, - acknowledge, unacknowledge, resolve, and close cases to streamline - investigations and follow-ups. - externalDocs: - description: Learn more about Cases in our documentation - url: https://coralogix.com/docs/user-guides/cases/ - - name: Connector Schema service - description: Retrieve connector schemas for notification center integrations - externalDocs: - description: Learn more about connectors in our documentation - url: >- - https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - - name: Connectors service - description: >- - View and manage your connectors - integration instances for notification - destinations - externalDocs: - description: Lean more about connectors in our documentation - url: >- - https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - - name: Contextual data integration service - description: Query for contextual data integration information. - externalDocs: - url: '' - - name: Custom Enrichments Service - description: Manage your enrichments. - externalDocs: - url: '' - - name: Dashboard folders service - description: Manage your dashboard folders. - externalDocs: - url: '' - - name: Dashboard service - description: Get information about the Coralogix Dashboard catalog. - externalDocs: - url: '' - - name: Data Usage Query service - description: >- - Query billable data usage through the public Coralogix API using daily or - hourly bucketed aggregations over supported labels. - externalDocs: - url: '' - - name: Data Usage Service - description: A service to manage data usage metrics. - externalDocs: - url: '' - - name: Enrichments Service - description: Manage your enrichments. - externalDocs: - url: '' - - name: Entities service - description: Query information about registered entities in the notification center - externalDocs: - description: Lean more about the notification center in our documentation - url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - - name: Events Service - description: A service for querying events. - externalDocs: - description: Learn more about alerts in our documentation - url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - - name: Events2Metrics Service - description: Manage your events2metrics. - externalDocs: - url: '' - - name: Extension deployment service - description: A service that enables querying for extension deployment information. - externalDocs: - description: Find out more about extensions in our documentation. - url: https://coralogix.com/docs/integrations/extensions/ - - name: Extension service - description: A service that enables querying for extension information. - externalDocs: - description: Learn more about extensions in our documentation. - url: https://coralogix.com/docs/integrations/extensions/ - - name: Folders for views service - description: Create and manage view folders. - externalDocs: - url: '' - - name: Global routers service - description: >- - View and manage your global routers - entities that direct notifications - to configured destinations based on conditions - externalDocs: - description: Lean more about global routers in our documentation - url: >- - https://coralogix.com/docs/user-guides/notification-center/routing/introduction/ - - name: IP access service - description: >- - IP access service provides the API for managing company IP access - settings. - externalDocs: - url: '' - - name: Incidents service - description: >- - Handle all operations related to incident management within Coralogix. - Identify, manage, and resolve incidents efficiently through automated - workflows and team collaboration. - externalDocs: - description: Find out more about incident management in our documentation - url: https://coralogix.com/docs/user-guides/alerting/incidents/ - - name: Integration service - description: A service that enables querying for integration information. - externalDocs: - description: Find out more about integrations in our documentation. - url: https://coralogix.com/docs/integrations/getting-started/ - - name: Metrics Data Archive Service - description: View and manage your storage targets for metrics. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - - name: Notifications testing service - description: >- - Test your notification center configurations including connectors, - presets, and templates - externalDocs: - description: Lean more about the notification center in our documentation - url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - - name: Outgoing webhooks service - externalDocs: - description: Find out more about outbound webhooks in our documentation. - url: >- - https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/ - - name: Policies Service - description: View and manage your TCO policies - externalDocs: - url: '' - - name: Presets service - description: >- - View and manage your presets - pre-configured templates for notification - content rendering - externalDocs: - description: Lean more about presets in our documentation - url: >- - https://coralogix.com/docs/user-guides/notification-center/presets/introduction/ - - name: Quota Allocation Rule Set service - description: Manage quota allocation rules for different entity types. - externalDocs: - url: '' - - name: Recording Rules Service - description: A service to manage recording rules. - externalDocs: - url: '' - - name: Retentions Service - description: View and manage retentions - externalDocs: - url: '' - - name: Role Management Service - description: Service for managing system and custom roles. - externalDocs: - url: '' - - name: Rule Groups Service - description: A service to manage rule groups. - externalDocs: - url: '' - - name: SAML Configuration Service - description: Manage your SAML configuration - externalDocs: - url: '' - - name: Scopes Service - description: A service to manage scopes - externalDocs: - url: '' - - name: Slos Service - description: A service for managing Service Level Objectives (SLOs). - externalDocs: - url: '' - - name: Target Service - description: View and manage your storage targets for logs. - externalDocs: - description: Find out more about archives - url: >- - https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - - name: Team Groups Management Service - description: Manage Team Groups. - externalDocs: - url: '' - - name: Users Management Service - description: >- - Manage team members (users) including creation, updates, search, and - status management. - externalDocs: - url: '' - - name: Views service - description: Create and manage views. - externalDocs: - url: '' servers: - url: https://api.coralogix.com/mgmt/openapi/5 - url: https://api.eu2.coralogix.com/mgmt/openapi/5