{ "openapi": "3.1.0", "info": { "title": "Coralogix Management API", "version": "5", "description": "Management API for the Coralogix observability platform. The base URL is region-specific: pick the `servers` entry matching your Coralogix domain. Authentication is a bearer API key." }, "security": [ { "apiKeyAuth": [] } ], "tags": [ { "name": "AI Applications Service", "description": "Manage the catalog of AI applications discovered from spans." }, { "name": "AI Evaluations Service", "description": "Manage AI evaluations and the custom evaluation catalog for AI applications." }, { "name": "API Keys Admin Service", "description": "Administrative operations for API Keys management." }, { "name": "API Keys Service", "description": "Manage your API Keys." }, { "name": "Actions Service", "description": "View and manage your Actions." }, { "name": "Alert Scheduler Rule service", "description": "Manage your alert scheduler rules." }, { "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." }, { "name": "Case Settings service", "description": "Manage case settings team configurations." }, { "name": "Cases notification service", "description": "Track notification adjacent data for cases." }, { "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." }, { "name": "Custom Enrichments Service", "description": "Manage your enrichments." }, { "name": "Dashboard folders service", "description": "Manage your dashboard folders." }, { "name": "Dashboard service", "description": "Manage your dashboards." }, { "name": "Data Usage Query Service", "description": "Query billable data usage through the public Coralogix API using daily or hourly bucketed aggregations over supported labels." }, { "name": "Enrichments Service", "description": "Manage your enrichments." }, { "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." }, { "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": "Fleet Manager Configuration Groups", "description": "Manage OpenTelemetry Collector configurations delivered to connected agents. A configuration group holds versioned families. Each family contains Collector YAML and selectors that match agent attributes. Activate a family to make its configurations available to matching agents." }, { "name": "Fleet Manager Configuration Overlays", "description": "Create, read, update, and archive fleet-manager configuration overlays." }, { "name": "Folders for views service", "description": "Create and manage view folders." }, { "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." }, { "name": "Identity Service", "description": "Resolve the team and user behind the presented credentials." }, { "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" }, { "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." }, { "name": "Recording Rules Service", "description": "A service to manage recording rules." }, { "name": "Retentions Service", "description": "View and manage retentions" }, { "name": "Role Management Service", "description": "Service for managing system and custom roles." }, { "name": "Rule Groups Service", "description": "A service to manage rule groups." }, { "name": "SAML Configuration Service", "description": "Manage your SAML configuration" }, { "name": "Scopes Service", "description": "A service to manage scopes" }, { "name": "Slos Service", "description": "A service for managing Service Level Objectives (SLOs)." }, { "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." }, { "name": "Teams Service", "description": "Deprecated. Read and manage the teams in an organization and the daily quota assigned to each of them." }, { "name": "Users Management Service", "description": "Manage team members (users) including creation, updates, search, and status management." }, { "name": "Views service", "description": "Create and manage views." } ], "paths": { "/aaa/api-keys/v3": { "get": { "description": "Retrieve all API keys for team members.", "operationId": "ApiKeysAdminService_GetTeamMembersApiKeys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamMembersApiKeysResponse" } } }, "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 Team Members API Keys", "tags": [ "API Keys Admin Service" ] }, "post": { "description": "Creates a new API key for the authenticated team.", "operationId": "ApiKeysService_CreateApiKey", "requestBody": { "content": { "application/json": { "schema": { "properties": { "accessPolicy": { "description": "JSON string representing the access policy for this API key. Defines granular permissions for users and groups.", "examples": [ "{\"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\":[]}" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "hashed": { "description": "Whether the value is stored as a one-way hash.", "examples": [ true ], "type": "boolean" }, "keyPermissions": { "$ref": "#/components/schemas/CreateApiKeyRequest.KeyPermissions" }, "name": { "description": "Display name.", "examples": [ "my_api_key" ], "minLength": 0, "type": "string" }, "owner": { "$ref": "#/components/schemas/Owner" } }, "title": "Create Api Key Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyResponse" } } }, "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": "Create API Key", "tags": [ "API Keys Service" ] } }, "/aaa/api-keys/v3/all/delete": { "post": { "description": "Delete specified API keys.", "operationId": "ApiKeysAdminService_DeleteApiKeys", "requestBody": { "content": { "application/json": { "schema": { "properties": { "keyIds": { "description": "List of API key IDs to delete.", "items": { "description": "List of API key IDs to delete.", "examples": [ "key_abc123" ], "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "title": "Delete API Keys Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteApiKeysResponse" } } }, "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": "Delete API Keys", "tags": [ "API Keys Admin Service" ] } }, "/aaa/api-keys/v3/all/status": { "post": { "description": "Activate or deactivate specified API keys.", "operationId": "ApiKeysAdminService_UpdateApiKeysStatus", "requestBody": { "content": { "application/json": { "schema": { "properties": { "updates": { "description": "The updates.", "items": { "$ref": "#/components/schemas/ApiKeyStatusUpdate" }, "minItems": 0, "type": "array" } }, "title": "Update API Keys Status Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeysStatusResponse" } } }, "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 API Keys Status", "tags": [ "API Keys Admin Service" ] } }, "/aaa/api-keys/v3/list/all": { "get": { "description": "Returns all API keys for the authenticated team.", "operationId": "ApiKeysService_GetApiKeys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiKeysResponse" } } }, "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 API Keys", "tags": [ "API Keys Service" ] } }, "/aaa/api-keys/v3/{key_id}": { "get": { "description": "Returns the details of the specified API key.", "operationId": "ApiKeysService_GetApiKey", "parameters": [ { "$ref": "#/components/parameters/key_id" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiKeyResponse" } } }, "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 API Key", "tags": [ "API Keys Service" ] }, "put": { "description": "Updates the specified API key.", "operationId": "ApiKeysService_UpdateApiKey", "parameters": [ { "$ref": "#/components/parameters/key_id" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "accessPolicy": { "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.", "examples": [ "{\"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\":[]}" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "isActive": { "description": "Whether the API key is active. Set to false to deactivate without deleting.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "newName": { "description": "New display name for the API key.", "examples": [ "my_new_name" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "permissions": { "$ref": "#/components/schemas/UpdateApiKeyRequest.Permissions" }, "presets": { "$ref": "#/components/schemas/Presets" } }, "title": "Update Api Key Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyResponse" } } }, "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 API Key", "tags": [ "API Keys Service" ] }, "delete": { "description": "Deletes the API key with the given ID.", "operationId": "ApiKeysService_DeleteApiKey", "parameters": [ { "description": "The unique identifier of the API key to delete.", "in": "path", "name": "key_id", "required": true, "schema": { "description": "The unique identifier of the API key to delete.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteApiKeyResponse" } } }, "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": "Delete API Key", "tags": [ "API Keys Service" ] } }, "/aaa/custom-roles/v1": { "get": { "description": "Returns all custom roles for the authenticated team.", "operationId": "RoleManagementService_ListCustomRoles", "parameters": [ { "description": "Team identifier.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team identifier.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCustomRolesResponse" } } }, "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 Custom Roles", "tags": [ "Role Management Service" ] }, "put": { "description": "Creates a new custom role.", "operationId": "RoleManagementService_CreateRole", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for creating a custom role.", "oneOf": [ { "required": [ "parentRoleId" ], "type": "object" }, { "required": [ "parentRoleName" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "parentRoleId" ], "type": "object" }, { "required": [ "parentRoleName" ], "type": "object" } ] }, "type": "object" } ], "properties": { "description": { "description": "Human-readable description.", "minLength": 0, "type": "string" }, "name": { "description": "Display name.", "minLength": 0, "type": "string" }, "parentRoleId": { "description": "The parent role id.", "format": "int64", "minimum": 0, "type": "integer" }, "parentRoleName": { "description": "The parent role name.", "minLength": 0, "type": "string" }, "permissions": { "description": "List of permissions.", "items": { "description": "List of permissions.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "teamId": { "description": "Team identifier.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoleResponse" } } }, "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": "Role already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create Role", "tags": [ "Role Management Service" ] } }, "/aaa/custom-roles/v1/{role_id}": { "get": { "description": "Returns the details of the specified custom role.", "operationId": "RoleManagementService_GetCustomRole", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomRoleResponse" } } }, "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": "Role not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Custom Role", "tags": [ "Role Management Service" ] }, "post": { "description": "Updates the specified custom role.", "operationId": "RoleManagementService_UpdateRole", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for updating a custom role.", "properties": { "newDescription": { "description": "The new description.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "newName": { "description": "The new name.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "newPermissions": { "$ref": "#/components/schemas/v2.Permissions" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleResponse" } } }, "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": "Role not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update Role", "tags": [ "Role Management Service" ] }, "delete": { "description": "Deletes the custom role with the specified ID.", "operationId": "RoleManagementService_DeleteRole", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRoleResponse" } } }, "description": "" }, "204": { "description": "Role deleted" }, "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": "Role not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete Role", "tags": [ "Role Management Service" ] }, "parameters": [ { "name": "role_id", "in": "path", "description": "The role id.", "required": true, "schema": { "minimum": 0, "type": "integer", "description": "The role id.", "format": "int64" } } ] }, "/aaa/identity/v1/whoami": { "get": { "description": "Returns the team, and where available the user, that the presented credentials authenticate as. Takes no parameters: the identity is derived entirely from the `Authorization` header. Authenticating with an API key resolves a team but no user, so `username` is absent in that case.", "operationId": "IdentityService_WhoAmI", "responses": { "200": { "content": { "application/json": { "example": { "teamId": 1234567, "teamName": "my-team", "teamUrl": "https://my-team.app.coralogix.com" }, "schema": { "$ref": "#/components/schemas/WhoAmIResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Missing or invalid credentials" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated team no longer exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Who am I", "tags": [ "Identity Service" ] } }, "/aaa/send-data-keys/v3": { "get": { "description": "Returns all send-data API keys for the authenticated team.", "operationId": "ApiKeysService_GetSendDataApiKeys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSendDataApiKeysResponse" } } }, "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 \"Send Data\" API Keys", "tags": [ "API Keys Service" ] } }, "/aaa/system-roles/v1": { "get": { "description": "Returns all built-in system roles.", "operationId": "RoleManagementService_ListSystemRoles", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSystemRolesResponse" } } }, "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 System Roles", "tags": [ "Role Management Service" ] } }, "/aaa/team-groups/v2": { "get": { "description": "Returns all team groups.", "operationId": "GroupsMgmtService_GetTeamGroups", "parameters": [ { "description": "Team to fetch team groups for. If not set, fetches groups associated with the logged in team.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team to fetch team groups for. If not set, fetches groups associated with the logged in team.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, { "description": "Page size.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Page size.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, { "description": "The page token.", "in": "query", "name": "page_token", "required": false, "schema": { "description": "The page token.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamGroupsResponse" } } }, "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 Team Groups", "tags": [ "Team Groups Management Service" ] }, "post": { "description": "Creates a new team group.", "operationId": "GroupsMgmtService_CreateTeamGroup", "requestBody": { "content": { "application/json": { "schema": { "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.", "properties": { "description": { "description": "Human-readable description of the team group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "External identifier for the group, used when the group is managed by an external identity provider.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "groupType": { "$ref": "#/components/schemas/GroupType", "x-coralogix-presence": true }, "name": { "description": "Unique display name for the new team group.", "minLength": 0, "type": "string" }, "roleId": { "description": "Identifier of the role to assign to this group.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "roleName": { "description": "Name of the role to assign to this group, as an alternative to `roleId`. Resolved against this team's custom roles and the global built-in roles. Matching is case-insensitive. The response reports the resolved role's id and canonical name. Mutually exclusive with `roleId`: setting both is rejected.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "scope": { "$ref": "#/components/schemas/v2.Scope" }, "teamId": { "description": "Team to associate the group with. If not set, uses the authenticated team.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "userIds": { "description": "The user ids.", "items": { "description": "The user ids.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "title": "CreateTeamGroupRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamGroupResponse" } } }, "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": "Team group already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create Team Group", "tags": [ "Team Groups Management Service" ] } }, "/aaa/team-groups/v2/id/{group_id}": { "get": { "description": "Returns the team group with the specified ID.", "operationId": "GroupsMgmtService_GetTeamGroup", "parameters": [ { "description": "The unique identifier of the team group.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the team group.", "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamGroupResponse" } } }, "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 group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Team Group", "tags": [ "Team Groups Management Service" ] } }, "/aaa/team-groups/v2/name/{name}": { "get": { "description": "Returns the team group with the specified name.", "operationId": "GroupsMgmtService_GetTeamGroupByName", "parameters": [ { "description": "The name of the team group to retrieve.", "in": "path", "name": "name", "required": true, "schema": { "description": "The name of the team group to retrieve.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamGroupByNameResponse" } } }, "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 group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Team Group By Name", "tags": [ "Team Groups Management Service" ] } }, "/aaa/team-groups/v2/{group_id}": { "put": { "description": "Updates the specified team group.", "operationId": "GroupsMgmtService_UpdateTeamGroup", "parameters": [ { "description": "Unique identifier of the team group to update.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "Unique identifier of the team group to update.", "format": "int64", "minimum": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to modify an existing team group's details, including its name, description, roles, users, and scope settings.", "properties": { "description": { "description": "New human-readable description for the team group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "New external identifier for the group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "groupType": { "$ref": "#/components/schemas/GroupType", "x-coralogix-presence": true }, "name": { "description": "New display name for the team group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "roleUpdate": { "$ref": "#/components/schemas/RoleUpdate" }, "scopeUpdate": { "$ref": "#/components/schemas/ScopeUpdate" }, "userUpdates": { "$ref": "#/components/schemas/UserUpdates" } }, "title": "UpdateTeamGroupRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamGroupResponse" } } }, "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 group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update Team Group", "tags": [ "Team Groups Management Service" ] }, "delete": { "description": "Deletes the team group with the specified ID.", "operationId": "GroupsMgmtService_DeleteTeamGroup", "parameters": [ { "description": "The unique identifier of the team group to delete.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the team group to delete.", "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTeamGroupResponse" } } }, "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 group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete Team Group", "tags": [ "Team Groups Management Service" ] } }, "/aaa/team-groups/v2/{group_id}/users/list": { "get": { "description": "Returns all users in the specified team group.", "operationId": "GroupsMgmtService_GetGroupUsers", "parameters": [ { "description": "The unique identifier of the team group whose users to list.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the team group whose users to list.", "format": "int64", "minimum": 0, "type": "integer" } }, { "description": "Pagination size. Defaults to 100 if empty.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Pagination size. Defaults to 100 if empty.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, { "description": "Optional pagination continuation token.", "in": "query", "name": "page_token", "required": false, "schema": { "description": "Optional pagination continuation token.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGroupUsersResponse" } } }, "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 group not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Group Users", "tags": [ "Team Groups Management Service" ] } }, "/aaa/team-saml/v1/active": { "post": { "description": "Activates or deactivates SAML for the team.", "operationId": "SamlConfigurationService_SetActive", "requestBody": { "content": { "application/json": { "schema": { "properties": { "isActive": { "description": "The is active.", "type": "boolean" }, "teamId": { "description": "Team identifier.", "format": "int64", "minimum": 0, "type": "integer" } }, "title": "Set Active Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.SetActiveResponse" } } }, "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": "Activate/Deactivate SAML", "tags": [ "SAML Configuration Service" ] } }, "/aaa/team-saml/v1/configuration": { "get": { "description": "Returns the current SAML configuration for the team.", "operationId": "SamlConfigurationService_GetConfiguration", "parameters": [ { "description": "The unique identifier of the team whose SAML configuration to retrieve.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "The unique identifier of the team whose SAML configuration to retrieve.", "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConfigurationResponse" } } }, "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 SAML Configuration", "tags": [ "SAML Configuration Service" ] } }, "/aaa/team-saml/v1/idp_parameters": { "post": { "description": "Sets the identity provider parameters for SAML.", "operationId": "SamlConfigurationService_SetIDPParameters", "requestBody": { "content": { "application/json": { "schema": { "properties": { "params": { "$ref": "#/components/schemas/IDPParameters" }, "teamId": { "description": "Team identifier.", "format": "int64", "minimum": 0, "type": "integer" } }, "title": "Set IDP Parameters Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetIDPParametersResponse" } } }, "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": "Set IDP Parameters", "tags": [ "SAML Configuration Service" ] } }, "/aaa/team-saml/v1/sp_parameters": { "get": { "description": "Returns the service provider parameters for SAML.", "operationId": "SamlConfigurationService_GetSPParameters", "parameters": [ { "description": "Team identifier.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team identifier.", "examples": [ 1234567 ], "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSPParametersResponse" } } }, "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 SP Parameters", "tags": [ "SAML Configuration Service" ] } }, "/aaa/team-scopes/v1": { "get": { "description": "Returns a data access scope by ID.", "operationId": "ScopesService_GetTeamScopesByIds", "parameters": [ { "description": "List of team scope identifiers to retrieve.", "in": "query", "name": "ids", "required": true, "schema": { "description": "List of team scope identifiers to retrieve.", "items": { "description": "List of team scope identifiers to retrieve.", "examples": [ "60c82be2-413f-4b8e-8201-7f5c51e2ef2b" ], "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScopesResponse" } } }, "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 Team Scopes By Ids", "tags": [ "Scopes Service" ] }, "put": { "description": "Updates an existing data access scope.", "operationId": "ScopesService_UpdateScope", "requestBody": { "content": { "application/json": { "schema": { "properties": { "defaultExpression": { "description": "The default expression.", "examples": [ "true" ], "minLength": 0, "type": "string" }, "description": { "description": "Human-readable description.", "examples": [ "The best scope" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "displayName": { "description": "The display name.", "examples": [ "my-scope" ], "minLength": 0, "type": "string" }, "filters": { "description": "List of filters.", "items": { "$ref": "#/components/schemas/scopes.v1.Filter" }, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier.", "examples": [ "60c82be2-413f-4b8e-8201-7f5c51e2ef2b" ], "minLength": 0, "type": "string" } }, "required": [ "id", "displayName", "filters", "defaultExpression" ], "title": "Update Scope Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScopeResponse" } } }, "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 Scope", "tags": [ "Scopes Service" ] }, "post": { "description": "Creates a new data access scope.", "operationId": "ScopesService_CreateScope", "requestBody": { "content": { "application/json": { "schema": { "properties": { "defaultExpression": { "description": "The default expression.", "examples": [ "true" ], "minLength": 0, "type": "string" }, "description": { "description": "Human-readable description.", "examples": [ "The best scope" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "displayName": { "description": "The display name.", "examples": [ "my-scope" ], "minLength": 0, "type": "string" }, "filters": { "description": "List of filters.", "items": { "$ref": "#/components/schemas/scopes.v1.Filter" }, "minItems": 0, "type": "array" } }, "required": [ "displayName", "filters" ], "title": "Create Scope Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScopeResponse" } } }, "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": "Create Scope", "tags": [ "Scopes Service" ] } }, "/aaa/team-scopes/v1/all/list": { "get": { "description": "Returns all data access scopes for the team.", "operationId": "ScopesService_GetTeamScopes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScopesResponse" } } }, "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 Team Scopes", "tags": [ "Scopes Service" ] } }, "/aaa/team-scopes/v1/{id}": { "delete": { "description": "Deletes the data access scope with the specified ID.", "operationId": "ScopesService_DeleteScope", "parameters": [ { "description": "Unique identifier.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier.", "examples": [ "60c82be2-413f-4b8e-8201-7f5c51e2ef2b" ], "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteScopeResponse" } } }, "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": "Delete Scope", "tags": [ "Scopes Service" ] } }, "/aaa/team-sec-ip-access/v1": { "get": { "description": "Returns the current IP access settings for the team.", "operationId": "IpAccessService_GetCompanyIpAccessSettings", "parameters": [ { "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.", "in": "query", "name": "id", "required": false, "schema": { "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.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanyIpAccessSettingsResponse" } } }, "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 company IP access settings", "tags": [ "IP access service" ] }, "put": { "description": "Updates the IP access restrictions for the team.", "operationId": "IpAccessService_ReplaceCompanyIpAccessSettings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "enableCoralogixCustomerSupportAccess": { "allOf": [ { "$ref": "#/components/schemas/CoralogixCustomerSupportAccess" } ], "description": "The Coralogix customer support access setting. Defaults to DISABLED if not provided.", "examples": [ "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED" ] }, "id": { "description": "Unique identifier of the existing IP access settings resource to replace.", "examples": [ "d662a2f1-21c3-493c-8f8a-595d3ab05ef3" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "ipAccess": { "description": "List of IP access entries to replace.", "items": { "$ref": "#/components/schemas/IpAccess" }, "minItems": 0, "type": "array" } }, "title": "Replace company IP access settings request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceCompanyIpAccessSettingsResponse" } } }, "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": "Replace company IP access settings", "tags": [ "IP access service" ] }, "post": { "description": "Sets the IP access restrictions for the team.", "operationId": "IpAccessService_CreateCompanyIpAccessSettings", "requestBody": { "content": { "application/json": { "schema": { "properties": { "enableCoralogixCustomerSupportAccess": { "allOf": [ { "$ref": "#/components/schemas/CoralogixCustomerSupportAccess" } ], "description": "The Coralogix customer support access setting.", "examples": [ "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED" ] }, "ipAccess": { "description": "List of IP access entries to create.", "items": { "$ref": "#/components/schemas/IpAccess" }, "minItems": 0, "type": "array" } }, "title": "Create company IP access settings request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyIpAccessSettingsResponse" } } }, "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": "Create company IP access settings", "tags": [ "IP access service" ] }, "delete": { "description": "Removes the IP access restrictions for the team.", "operationId": "IpAccessService_DeleteCompanyIpAccessSettings", "parameters": [ { "description": "The unique identifier of the company IP access settings to delete.", "in": "query", "name": "id", "required": false, "schema": { "description": "The unique identifier of the company IP access settings to delete.", "examples": [ "d662a2f1-21c3-493c-8f8a-595d3ab05ef3" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCompanyIpAccessSettingsResponse" } } }, "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": "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.", "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.", "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. A value greater than 0.01 moves that value minus 0.01 from the organization's default team to the new team. The service ignores an omitted value, or a value of 0.01 or less, and gives the team the minimum quota. The service stores the quota as a 32-bit float.", "format": "double", "type": "number", "x-coralogix-presence": true }, "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. Unique in the organization: a name that another team has answers 400.", "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.", "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.", "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. Must be greater than 0: the service answers 400 for 0 or less. The quota moves between this team and the organization's default team, and the service stores it as a 32-bit float.", "format": "double", "type": "number", "x-coralogix-presence": true }, "teamName": { "description": "New display name for the team. Omit to keep the current name. A name that another team of the organization has is rejected.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "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.", "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/users/v2": { "get": { "description": "Searches for team members by query.", "operationId": "UsersMgmtService_SearchUsers", "parameters": [ { "description": "Team ID to search within. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team ID to search within. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "format": "int64", "minimum": 0, "type": "integer" } }, { "description": "Optional filter by username (partial match supported)", "in": "query", "name": "username", "required": false, "schema": { "description": "Optional filter by username (partial match supported)", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, { "description": "Optional filter by user status (e.g., 'active', 'inactive')", "in": "query", "name": "status", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/UserStatus" } ], "description": "Optional filter by user status (e.g., 'active', 'inactive')", "x-coralogix-presence": true } }, { "description": "Number of results per page", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Number of results per page", "format": "int64", "minimum": 0, "type": "integer" } }, { "description": "Token for pagination to retrieve the next page of results", "in": "query", "name": "page_token", "required": false, "schema": { "description": "Token for pagination to retrieve the next page of results", "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchUsersResponse" } } }, "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": "Search Users", "tags": [ "Users Management Service" ] }, "put": { "description": "Updates team members for the specified team.", "operationId": "UsersMgmtService_UpdateUsers", "parameters": [ { "description": "Team ID containing the users to update. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team ID containing the users to update. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "format": "int64", "minimum": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "List of users to update. Multiple users can be updated in a single request.", "items": { "$ref": "#/components/schemas/UpdateUserRequest" }, "minItems": 0, "type": "array" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsersResponse" } } }, "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": "User not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update Users", "tags": [ "Users Management Service" ] }, "post": { "description": "Adds members to the specified team.", "operationId": "UsersMgmtService_CreateUsers", "parameters": [ { "description": "Team ID where the users will be created. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team ID where the users will be created. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "format": "int64", "minimum": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "List of users to create. Multiple users can be created in a single request.", "items": { "$ref": "#/components/schemas/CreateUserRequest" }, "minItems": 0, "type": "array" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUsersResponse" } } }, "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" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "User already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create Users", "tags": [ "Users Management Service" ] } }, "/aaa/users/v2/{user_account_id}": { "get": { "description": "Returns the details of a specific team member.", "operationId": "UsersMgmtService_GetUser", "parameters": [ { "description": "User account ID to retrieve", "in": "path", "name": "user_account_id", "required": true, "schema": { "description": "User account ID to retrieve", "format": "int64", "minimum": 0, "type": "integer" } }, { "description": "Team ID to search within. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "in": "query", "name": "team_id", "required": false, "schema": { "description": "Team ID to search within. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "format": "int64", "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } } }, "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": "User not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get User", "tags": [ "Users Management Service" ] } }, "/aaa/users/v2:updateStatuses": { "patch": { "description": "Updates the active status of multiple team members.", "operationId": "UsersMgmtService_UpdateUsersStatuses", "requestBody": { "content": { "application/json": { "schema": { "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).", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/UserStatus" } ], "description": "New status for the users: Active (enables system access) or Inactive (disables system access)" }, "teamId": { "description": "Team ID containing the users to update. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.", "format": "int64", "minimum": 0, "type": "integer" }, "userAccountIds": { "description": "List of user account IDs to update. All users will be set to the same status.", "items": { "description": "List of user account IDs to update. All users will be set to the same status.", "format": "int64", "minimum": 0, "type": "integer" }, "minItems": 0, "type": "array" }, "userIds": { "description": "Stable ids of the users to update, as an alternative to `userAccountIds`. All users will be set to the same status. Mutually exclusive with `userAccountIds`: set exactly one of the two.", "items": { "description": "Stable ids of the users to update, as an alternative to `userAccountIds`. All users will be set to the same status. Mutually exclusive with `userAccountIds`: set exactly one of the two.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "title": "UpdateUserStatusRequest", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsersStatusesResponse" } } }, "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": "User not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Activate/Revoke Users", "tags": [ "Users Management Service" ] } }, "/actions/actions/v2": { "get": { "description": "Returns all actions for the team.", "operationId": "ActionsService_ListActions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListActionsResponse" } } }, "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 Actions", "tags": [ "Actions Service" ] }, "put": { "description": "Replaces the action with the given id. The request replaces the lists `applicationNames`, `subsystemNames`, and `urlFields`, so an omitted list is cleared. The optional `description` and `dpxlFilter` keep their stored value when omitted: send an empty string to clear them. A request that changes `isPrivate` fails with `412 Precondition Failed`.", "operationId": "ActionsService_ReplaceAction", "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "$ref": "#/components/schemas/v2.Action" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceActionResponse" } } }, "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": "Replace Action", "tags": [ "Actions Service" ] }, "post": { "description": "Creates a new action.", "operationId": "ActionsService_CreateAction", "requestBody": { "content": { "application/json": { "schema": { "properties": { "applicationNames": { "description": "The application names.", "items": { "description": "The application names.", "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dpxlFilter": { "description": "The dpxl filter.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isPrivate": { "default": true, "description": "Whether only the creating user sees the action. Defaults to true. A private action needs a user, so a request with an API key must set false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 50, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "sourceType": { "$ref": "#/components/schemas/v2.SourceType" }, "subsystemNames": { "description": "The subsystem names.", "items": { "description": "The subsystem names.", "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "url": { "description": "URL. Must start with http:// or https://.", "maxLength": 32768, "minLength": 1, "pattern": "^https?://.*$", "type": "string", "x-coralogix-presence": true }, "urlFields": { "description": "The url fields. Each field requires both name and required, and names must be unique within the list.", "items": { "$ref": "#/components/schemas/UrlField" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActionResponse" } } }, "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": "Create Action", "tags": [ "Actions Service" ] } }, "/actions/actions/v2/{id}": { "get": { "description": "Returns the details of a specific action.", "operationId": "ActionsService_GetAction", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActionResponse" } } }, "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 Action", "tags": [ "Actions Service" ] }, "delete": { "description": "Deletes the action with the specified ID.", "operationId": "ActionsService_DeleteAction", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteActionResponse" } } }, "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": "Delete Action", "tags": [ "Actions Service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "description": "Unique identifier.", "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", "x-coralogix-presence": true } } ] }, "/actions/batch/v2": { "post": { "description": "Creates multiple actions in a single request.", "operationId": "ActionsService_AtomicBatchExecuteActions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "requests": { "description": "The requests.", "items": { "$ref": "#/components/schemas/ActionExecutionRequest" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicBatchExecuteActionsResponse" } } }, "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": "Atomic Batch Execute Actions", "tags": [ "Actions Service" ] } }, "/actions/order/v2": { "post": { "description": "Updates the display order of actions.", "operationId": "ActionsService_OrderActions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "privateActionsOrder": { "additionalProperties": { "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "description": "The private actions order.", "type": "object" }, "sharedActionsOrder": { "additionalProperties": { "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer" }, "description": "The shared actions order.", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderActionsResponse" } } }, "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": "Order Actions", "tags": [ "Actions Service" ] } }, "/ai/applications/v3": { "get": { "description": "Lists AI applications, optionally filtered by evaluation type.", "operationId": "AiApplicationsService_ListAiApplications", "parameters": [ { "description": "Number of items per page. Default 200 if omitted.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Number of items per page. Default 200 if omitted.", "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, { "description": "Zero-based page offset. Default 0 if omitted.", "in": "query", "name": "page_offset", "required": false, "schema": { "description": "Zero-based page offset. Default 0 if omitted.", "format": "int64", "maximum": 10000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, { "description": "Optional filter: only include applications that have at least one evaluation of any of these types.", "in": "query", "name": "evaluation_types", "required": false, "schema": { "description": "Optional filter: only include applications that have at least one evaluation of any of these types.", "items": { "$ref": "#/components/schemas/EvaluationType" }, "maxItems": 100, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aiApplications": [ { "application": "checkout", "companyId": "12345", "createdAt": "2026-06-02T15:30:00.000Z", "guardrailsIntegrated": true, "id": "175677d1-fc90-4a89-9e35-0590b188ebb2", "subsystem": "api", "updatedAt": "2026-06-02T15:35:00.000Z" } ] }, "schema": { "$ref": "#/components/schemas/ListAiApplicationsResponse" } } }, "description": "" } }, "summary": "List AI applications", "tags": [ "AI Applications Service" ] } }, "/ai/applications/v3/{id}": { "get": { "description": "Gets an AI application by its unique identifier.", "operationId": "AiApplicationsService_GetAiApplicationById", "parameters": [ { "description": "Unique identifier of the AI application.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the AI application.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aiApplication": { "application": "checkout", "companyId": "12345", "createdAt": "2026-06-02T15:30:00.000Z", "guardrailsIntegrated": true, "id": "175677d1-fc90-4a89-9e35-0590b188ebb2", "subsystem": "api", "updatedAt": "2026-06-02T15:35:00.000Z" } }, "schema": { "$ref": "#/components/schemas/GetAiApplicationByIdResponse" } } }, "description": "" } }, "summary": "Get AI application", "tags": [ "AI Applications Service" ] }, "delete": { "description": "Deletes an AI application by its unique identifier.", "operationId": "AiApplicationsService_DeleteAiApplication", "parameters": [ { "description": "Unique identifier of the AI application to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the AI application to delete.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "id": "175677d1-fc90-4a89-9e35-0590b188ebb2" }, "schema": { "$ref": "#/components/schemas/DeleteAiApplicationResponse" } } }, "description": "" } }, "summary": "Delete AI application", "tags": [ "AI Applications Service" ] } }, "/ai/custom-evaluations/v3": { "get": { "description": "Lists all custom evaluations defined in the catalog.", "operationId": "AiEvaluationsService_GetCustomEvaluations", "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "applicationIds": [ "175677d1-fc90-4a89-9e35-0590b188ebb2" ], "config": { "examples": [ { "conversation": "User: is our product better than CompetitorY?", "score": "1" } ], "instructions": "Flag the response if it mentions a competitor.", "policyType": "quality", "safe": "No competitor mentioned", "shouldIncludeSystemPrompt": false, "violates": "Mentions a competitor" }, "description": "Flags competitor references in responses.", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d", "name": "No competitor mentions" } ] }, "schema": { "$ref": "#/components/schemas/GetCustomEvaluationsResponse" } } }, "description": "" } }, "summary": "List custom evaluations", "tags": [ "AI Evaluations Service" ] }, "post": { "description": "Creates a new custom evaluation in the catalog.", "operationId": "AiEvaluationsService_CreateCustomEvaluation", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a custom evaluation in the catalog.", "properties": { "applicationIds": { "description": "IDs of AI applications to link this custom evaluation to.", "items": { "description": "IDs of AI applications to link this custom evaluation to.", "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" }, "maxItems": 1024, "minItems": 0, "type": "array" }, "description": { "description": "Human-readable description.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "examples": { "description": "Example conversations and expected scores.", "items": { "$ref": "#/components/schemas/CustomEvaluationExample" }, "maxItems": 100, "minItems": 0, "type": "array" }, "instructions": { "description": "Instructions sent to the LLM evaluator.", "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "name": { "description": "Display name of the custom evaluation.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "policyType": { "description": "Policy type identifier.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "safe": { "description": "Description of what counts as safe.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "shouldIncludeSystemPrompt": { "description": "Whether to include the system prompt in the LLM input.", "type": "boolean" }, "violates": { "description": "Description of what counts as violating the policy.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "item": { "applicationIds": [ "175677d1-fc90-4a89-9e35-0590b188ebb2" ], "config": { "examples": [ { "conversation": "User: is our product better than CompetitorY?", "score": "1" } ], "instructions": "Flag the response if it mentions a competitor.", "policyType": "quality", "safe": "No competitor mentioned", "shouldIncludeSystemPrompt": false, "violates": "Mentions a competitor" }, "description": "Flags competitor references in responses.", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d", "name": "No competitor mentions" } }, "schema": { "$ref": "#/components/schemas/CreateCustomEvaluationResponse" } } }, "description": "" }, "201": { "content": { "application/json": { "example": { "item": { "applicationIds": [ "175677d1-fc90-4a89-9e35-0590b188ebb2" ], "config": { "examples": [ { "conversation": "User: is our product better than CompetitorY?", "score": "1" } ], "instructions": "Flag the response if it mentions a competitor.", "policyType": "quality", "safe": "No competitor mentioned", "shouldIncludeSystemPrompt": false, "violates": "Mentions a competitor" }, "description": "Flags competitor references in responses.", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d", "name": "No competitor mentions" } }, "schema": { "$ref": "#/components/schemas/CreateCustomEvaluationResponse" } } }, "description": "Custom evaluation created" } }, "summary": "Create custom evaluation", "tags": [ "AI Evaluations Service" ] } }, "/ai/custom-evaluations/v3/by-application/{application_id}": { "get": { "description": "Lists custom evaluations linked to a specific AI application.", "operationId": "AiEvaluationsService_ListCustomEvaluationsForApplication", "parameters": [ { "description": "Unique identifier of the AI application.", "in": "path", "name": "application_id", "required": true, "schema": { "description": "Unique identifier of the AI application.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "items": [ { "applicationIds": [ "175677d1-fc90-4a89-9e35-0590b188ebb2" ], "config": { "examples": [ { "conversation": "User: is our product better than CompetitorY?", "score": "1" } ], "instructions": "Flag the response if it mentions a competitor.", "policyType": "quality", "safe": "No competitor mentioned", "shouldIncludeSystemPrompt": false, "violates": "Mentions a competitor" }, "description": "Flags competitor references in responses.", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d", "name": "No competitor mentions" } ] }, "schema": { "$ref": "#/components/schemas/ListCustomEvaluationsForApplicationResponse" } } }, "description": "" } }, "summary": "List custom evaluations for application", "tags": [ "AI Evaluations Service" ] } }, "/ai/custom-evaluations/v3/{id}": { "delete": { "description": "Deletes a custom evaluation from the catalog.", "operationId": "AiEvaluationsService_DeleteCustomEvaluation", "parameters": [ { "description": "Unique identifier of the custom evaluation to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the custom evaluation to delete.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d" }, "schema": { "$ref": "#/components/schemas/DeleteCustomEvaluationResponse" } } }, "description": "" } }, "summary": "Delete custom evaluation", "tags": [ "AI Evaluations Service" ] }, "patch": { "description": "Updates one or more fields of an existing custom evaluation.", "operationId": "AiEvaluationsService_UpdateCustomEvaluation", "parameters": [ { "description": "Unique identifier of the custom evaluation to update.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the custom evaluation to update.", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update a custom evaluation in the catalog.", "properties": { "description": { "description": "Human-readable description.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "examples": { "description": "Example conversations and expected scores.", "items": { "$ref": "#/components/schemas/CustomEvaluationExample" }, "maxItems": 100, "minItems": 0, "type": "array" }, "instructions": { "description": "Instructions sent to the LLM evaluator.", "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name of the custom evaluation.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "policyType": { "description": "Policy type identifier.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "safe": { "description": "Description of what counts as safe.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "shouldIncludeSystemPrompt": { "description": "Whether to include the system prompt in the LLM input.", "type": "boolean", "x-coralogix-presence": true }, "updateMask": { "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.", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*(,[a-zA-Z_][a-zA-Z0-9_]*)*$", "type": "string", "x-coralogix-presence": true }, "violates": { "description": "Description of what counts as violating the policy.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "item": { "applicationIds": [ "175677d1-fc90-4a89-9e35-0590b188ebb2" ], "config": { "examples": [ { "conversation": "User: is our product better than CompetitorY?", "score": "1" } ], "instructions": "Flag the response if it mentions a competitor.", "policyType": "quality", "safe": "No competitor mentioned", "shouldIncludeSystemPrompt": false, "violates": "Mentions a competitor" }, "description": "Flags competitor references in responses.", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d", "name": "No competitor mentions" } }, "schema": { "$ref": "#/components/schemas/UpdateCustomEvaluationResponse" } } }, "description": "" } }, "summary": "Update custom evaluation", "tags": [ "AI Evaluations Service" ] } }, "/ai/custom-evaluations/v3/{id}/applications/{application_id}": { "post": { "description": "Associates a custom evaluation with an AI application.", "operationId": "AiEvaluationsService_LinkCustomEvaluation", "parameters": [ { "description": "Unique identifier of the AI application to link to.", "in": "path", "name": "application_id", "required": true, "schema": { "description": "Unique identifier of the AI application to link to.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "applicationId": "175677d1-fc90-4a89-9e35-0590b188ebb2", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d" }, "schema": { "$ref": "#/components/schemas/LinkCustomEvaluationResponse" } } }, "description": "" } }, "summary": "Link custom evaluation to application", "tags": [ "AI Evaluations Service" ] }, "delete": { "description": "Removes the association between a custom evaluation and an AI application.", "operationId": "AiEvaluationsService_UnlinkCustomEvaluationFromApp", "parameters": [ { "description": "Unique identifier of the AI application to unlink from.", "in": "path", "name": "application_id", "required": true, "schema": { "description": "Unique identifier of the AI application to unlink from.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "applicationId": "175677d1-fc90-4a89-9e35-0590b188ebb2", "id": "3a9b8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d" }, "schema": { "$ref": "#/components/schemas/UnlinkCustomEvaluationFromAppResponse" } } }, "description": "" } }, "summary": "Unlink custom evaluation from application", "tags": [ "AI Evaluations Service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier of the custom evaluation.", "required": true, "schema": { "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." } } ] }, "/ai/evaluation-counts/v3/per-type": { "get": { "description": "Returns the count of AI applications grouped by evaluation type.", "operationId": "AiEvaluationsService_CountAiAppsPerEvalType", "responses": { "200": { "content": { "application/json": { "example": { "counts": { "PII": 3, "PROMPT_INJECTION": 1, "TOXICITY": 0 } }, "schema": { "$ref": "#/components/schemas/CountAiAppsPerEvalTypeResponse" } } }, "description": "" } }, "summary": "Count applications per evaluation type", "tags": [ "AI Evaluations Service" ] } }, "/ai/evaluations/v3": { "get": { "description": "Lists AI evaluations, optionally filtered by application, subsystem, or evaluation type.", "operationId": "AiEvaluationsService_ListAiEvaluations", "parameters": [ { "description": "Filter by application name.", "in": "query", "name": "application", "required": false, "schema": { "description": "Filter by application name.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true } }, { "description": "Filter by subsystem.", "in": "query", "name": "subsystem", "required": false, "schema": { "description": "Filter by subsystem.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true } }, { "description": "Filter by evaluation type.", "in": "query", "name": "evaluation_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluationType" } ], "description": "Filter by evaluation type.", "x-coralogix-presence": true } }, { "description": "Number of items per page. Default 200 if omitted.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Number of items per page. Default 200 if omitted.", "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, { "description": "Zero-based page offset. Default 0 if omitted.", "in": "query", "name": "page_offset", "required": false, "schema": { "description": "Zero-based page offset. Default 0 if omitted.", "format": "int64", "maximum": 10000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "example": { "aiEvaluations": [ { "application": "checkout", "companyId": "12345", "config": { "competition": { "competitors": [ "Acme" ] } }, "createdAt": "2026-06-02T15:30:00.000Z", "createdBy": "7b1c0e2a-3d4f-5a6b-8c9d-0e1f2a3b4c5d", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "isEnabled": true, "subsystem": "api", "target": "RESPONSE", "threshold": 0.7, "updatedAt": "2026-06-02T15:35:00.000Z" } ] }, "schema": { "$ref": "#/components/schemas/ListAiEvaluationsResponse" } } }, "description": "" } }, "summary": "List AI evaluations", "tags": [ "AI Evaluations Service" ] }, "post": { "description": "Creates a new AI evaluation for an application.", "operationId": "AiEvaluationsService_CreateAiEvaluation", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new AI evaluation.", "properties": { "application": { "description": "Name of the AI application this evaluation belongs to.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "config": { "allOf": [ { "$ref": "#/components/schemas/EvaluationConfig" } ], "description": "Type-specific configuration (oneof)." }, "isEnabled": { "description": "Whether the evaluation should start active. Defaults to false when omitted.", "type": "boolean" }, "subsystem": { "description": "Subsystem within the application.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" }, "target": { "allOf": [ { "$ref": "#/components/schemas/EvaluationTarget" } ], "description": "What the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION.", "x-coralogix-presence": true }, "threshold": { "description": "Score threshold. Must be between 0.0 and 1.0 inclusive.", "format": "double", "maximum": 1, "minimum": 0, "type": "number", "x-coralogix-presence": true } }, "required": [ "application", "subsystem", "target", "config" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "aiEvaluation": { "application": "checkout", "companyId": "12345", "config": { "competition": { "competitors": [ "Acme" ] } }, "createdAt": "2026-06-02T15:30:00.000Z", "createdBy": "7b1c0e2a-3d4f-5a6b-8c9d-0e1f2a3b4c5d", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "isEnabled": true, "subsystem": "api", "target": "RESPONSE", "threshold": 0.7, "updatedAt": "2026-06-02T15:35:00.000Z" } }, "schema": { "$ref": "#/components/schemas/CreateAiEvaluationResponse" } } }, "description": "" }, "201": { "content": { "application/json": { "example": { "aiEvaluation": { "application": "checkout", "companyId": "12345", "config": { "competition": { "competitors": [ "Acme" ] } }, "createdAt": "2026-06-02T15:30:00.000Z", "createdBy": "7b1c0e2a-3d4f-5a6b-8c9d-0e1f2a3b4c5d", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "isEnabled": true, "subsystem": "api", "target": "RESPONSE", "threshold": 0.7, "updatedAt": "2026-06-02T15:35:00.000Z" } }, "schema": { "$ref": "#/components/schemas/CreateAiEvaluationResponse" } } }, "description": "AI evaluation created" } }, "summary": "Create AI evaluation", "tags": [ "AI Evaluations Service" ] } }, "/ai/evaluations/v3/{id}": { "get": { "description": "Gets an AI evaluation by its unique identifier.", "operationId": "AiEvaluationsService_GetAiEvaluation", "parameters": [ { "description": "Unique identifier of the AI evaluation.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the AI evaluation.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aiEvaluation": { "application": "checkout", "companyId": "12345", "config": { "competition": { "competitors": [ "Acme" ] } }, "createdAt": "2026-06-02T15:30:00.000Z", "createdBy": "7b1c0e2a-3d4f-5a6b-8c9d-0e1f2a3b4c5d", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "isEnabled": true, "subsystem": "api", "target": "RESPONSE", "threshold": 0.7, "updatedAt": "2026-06-02T15:35:00.000Z" } }, "schema": { "$ref": "#/components/schemas/GetAiEvaluationResponse" } } }, "description": "" } }, "summary": "Get AI evaluation", "tags": [ "AI Evaluations Service" ] }, "delete": { "description": "Deletes an AI evaluation by its unique identifier.", "operationId": "AiEvaluationsService_DeleteAiEvaluation", "parameters": [ { "description": "Unique identifier of the AI evaluation to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the AI evaluation to delete.", "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" } } ], "responses": { "200": { "content": { "application/json": { "example": { "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d" }, "schema": { "$ref": "#/components/schemas/DeleteAiEvaluationResponse" } } }, "description": "" } }, "summary": "Delete AI evaluation", "tags": [ "AI Evaluations Service" ] }, "patch": { "description": "Updates one or more fields of an existing AI evaluation.", "operationId": "AiEvaluationsService_UpdateAiEvaluation", "parameters": [ { "description": "Unique identifier of the AI evaluation to update.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the AI evaluation to update.", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update an existing AI evaluation.", "properties": { "application": { "description": "Name of the AI application this evaluation belongs to.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "config": { "allOf": [ { "$ref": "#/components/schemas/EvaluationConfig" } ], "description": "Type-specific configuration (oneof)." }, "isEnabled": { "description": "Whether the evaluation is active.", "type": "boolean", "x-coralogix-presence": true }, "subsystem": { "description": "Subsystem within the application.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "target": { "allOf": [ { "$ref": "#/components/schemas/EvaluationTarget" } ], "description": "What the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION.", "x-coralogix-presence": true }, "threshold": { "description": "Score threshold. Must be between 0.0 and 1.0 inclusive.", "format": "double", "maximum": 1, "minimum": 0, "type": "number", "x-coralogix-presence": true }, "updateMask": { "description": "Comma-separated list of top-level field paths to update. Dotted paths are rejected. When provided, only the listed fields are touched; a listed field that is absent from the request body is cleared, except application, subsystem, target, config, and isEnabled, which cannot be cleared. When omitted, only fields present in the body are updated.", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*(,[a-zA-Z_][a-zA-Z0-9_]*)*$", "type": "string", "x-coralogix-presence": true } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "aiEvaluation": { "application": "checkout", "companyId": "12345", "config": { "competition": { "competitors": [ "Acme" ] } }, "createdAt": "2026-06-02T15:30:00.000Z", "createdBy": "7b1c0e2a-3d4f-5a6b-8c9d-0e1f2a3b4c5d", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "isEnabled": true, "subsystem": "api", "target": "RESPONSE", "threshold": 0.7, "updatedAt": "2026-06-02T15:35:00.000Z" } }, "schema": { "$ref": "#/components/schemas/UpdateAiEvaluationResponse" } } }, "description": "" } }, "summary": "Update AI evaluation", "tags": [ "AI Evaluations Service" ] } }, "/ai/model-pricing/v3": { "get": { "description": "Returns the company-wide custom model pricing configuration.", "operationId": "AiApplicationsService_GetCompanyModelPricing", "responses": { "200": { "content": { "application/json": { "example": { "pricing": { "companyId": "12345", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "prices": { "gpt-4o": { "inputPricePerMillionTokens": 2.5, "outputPricePerMillionTokens": 10 } } } }, "schema": { "$ref": "#/components/schemas/GetCompanyModelPricingResponse" } } }, "description": "" } }, "summary": "Get company model pricing", "tags": [ "AI Applications Service" ] }, "put": { "description": "Replaces the company-wide custom model pricing configuration.", "operationId": "AiApplicationsService_SetCompanyModelPricing", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to set (replace) the company's custom model pricing.", "properties": { "prices": { "additionalProperties": { "$ref": "#/components/schemas/ModelPrice" }, "description": "Full replacement map of model name to custom price.", "type": "object" } }, "required": [ "prices" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "pricing": { "companyId": "12345", "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d", "prices": { "gpt-4o": { "inputPricePerMillionTokens": 2.5, "outputPricePerMillionTokens": 10 } } } }, "schema": { "$ref": "#/components/schemas/SetCompanyModelPricingResponse" } } }, "description": "" } }, "summary": "Set company model pricing", "tags": [ "AI Applications Service" ] }, "delete": { "description": "Deletes the company-wide custom model pricing configuration.", "operationId": "AiApplicationsService_DeleteCompanyModelPricing", "responses": { "200": { "content": { "application/json": { "example": { "id": "9d4f7c1a-2b3e-4f5a-8c1d-6e2f9a0b1c2d" }, "schema": { "$ref": "#/components/schemas/DeleteCompanyModelPricingResponse" } } }, "description": "" } }, "summary": "Delete company model pricing", "tags": [ "AI Applications Service" ] } }, "/alerts/alerts/v3": { "get": { "description": "Returns all alert definitions for the team.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertDefsService_ListAlertDefs", "parameters": [ { "description": "Filter to apply to the list of alert definitions", "in": "query", "name": "query_filter", "required": false, "schema": { "description": "Filter configuration for alert defs", "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" } }, "title": "AlertDef query filter", "type": "object" } }, { "description": "Pagination settings for the list of alert definitions", "in": "query", "name": "pagination", "required": false, "schema": { "properties": { "pageSize": { "description": "Page size.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "The page token.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "type": "object" } }, { "description": "Ordering settings for the list of alert definitions", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "List of fields to order alert definitions by", "properties": { "orderBys": { "description": "Order by fields for alert definitions", "items": { "description": "A data structure that specifies the field and direction for ordering alert definitions", "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOrderByDirection" } ], "description": "Direction for ordering", "examples": [ "ALERT_DEF_ORDER_BY_DIRECTION_DESC" ] }, "fieldName": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOrderByFields" } ], "description": "Field name to order by", "examples": [ "ALERT_DEF_ORDER_BY_FIELDS_UPDATED_TIME" ] } }, "title": "Alert definition order by", "type": "object" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "title": "Alert definition order by list", "type": "object" } }, { "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.", "in": "query", "name": "include_access_permissions", "required": false, "schema": { "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.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertDefsResponse" } } }, "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 a list of all accessible alert definitions", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] }, "put": { "description": "Updates an existing alert definition.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_ReplaceAlertDef", "requestBody": { "content": { "application/json": { "schema": { "description": "A request to replace an existing alert definition", "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": { "description": "Alert definition ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true } }, "title": "Replace alert definition request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceAlertDefResponse" } } }, "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": "Replace an alert definition", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] }, "post": { "description": "Creates a new alert definition.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_CreateAlertDef", "requestBody": { "content": { "application/json": { "schema": { "description": "A request to create a new alert definition", "properties": { "accessPolicy": { "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.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "alertDefProperties": { "allOf": [ { "$ref": "#/components/schemas/AlertDefProperties" } ], "description": "The properties of the alert definition" } }, "title": "Create alert definition request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAlertDefResponse" } } }, "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": "Create an alert", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] } }, "/alerts/alerts/v3/all/counts": { "get": { "description": "Returns counts for different filter options based on the provided filters\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertDefsService_FilterOptionCounts", "parameters": [ { "description": "The filter to apply when counting options", "in": "query", "name": "query_filter", "required": false, "schema": { "description": "Filter configuration for counting filter options", "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" } }, "title": "Filter option counts filter", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterOptionCountsResponse" } } }, "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 counts for filter options", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] } }, "/alerts/alerts/v3/all/create": { "post": { "description": "Creates multiple alert definitions in a single request. The operation is best-effort - definitions that fail to be created are reported in the response and do not prevent creation of the others. Limited to 100 alert definitions per request.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_BulkCreateAlertDefs", "requestBody": { "content": { "application/json": { "schema": { "description": "A request to create multiple alert definitions", "properties": { "alertDefsToCreate": { "description": "List of alert definitions to create. Limited to 100 alert definitions per request.", "items": { "$ref": "#/components/schemas/AlertDefToCreate" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "alertDefsToCreate" ], "title": "Bulk create alert definitions request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alertDefs": [ { "alertDefProperties": { "description": "Fires when the error rate exceeds the threshold.", "enabled": true, "name": "High error rate", "priority": "ALERT_DEF_PRIORITY_P2", "type": "ALERT_DEF_TYPE_LOGS_THRESHOLD" }, "alertVersionId": "223e4567-e89b-12d3-a456-426614174000", "createdTime": "2026-07-01T08:30:00.000Z", "id": "123e4567-e89b-12d3-a456-426614174000", "updatedTime": "2026-07-01T08:30:00.000Z" } ], "failedToCreateAlertDefs": [ { "index": 1, "reason": "Alert definition name must not be empty." } ] }, "schema": { "$ref": "#/components/schemas/BulkCreateAlertDefsResponse" } } }, "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": "Bulk create alert definitions", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] } }, "/alerts/alerts/v3/all/delete": { "post": { "description": "Delete multiple alert definitions by their IDs. The operation is atomic - either all alerts are deleted or none are. Limited to 100 alert definitions per request.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_BulkDeleteAlertDefs", "requestBody": { "content": { "application/json": { "schema": { "description": "A request to delete multiple alert defintions by their IDs", "properties": { "ids": { "description": "List of alert definition IDs to delete.", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ], "items": { "description": "List of alert definition IDs to delete.", "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" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "title": "Bulk delete alert definitions request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteAlertDefsResponse" } } }, "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": "Bulk delete alert definitions", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] } }, "/alerts/alerts/v3/all/download": { "get": { "description": "Download alert definitions in base64-encoded byte format. When ids are provided, only those alert definitions are downloaded; otherwise all accessible alert definitions are downloaded.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertDefsService_DownloadAlerts", "parameters": [ { "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).", "in": "query", "name": "ids", "required": false, "schema": { "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).", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ], "items": { "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).", "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" }, "maxItems": 1000, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadAlertsResponse" } } }, "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": "Download alerts", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] } }, "/alerts/alerts/v3/all/events": { "get": { "description": "Returns all alert events.", "operationId": "EventsService_ListAlertEvents", "parameters": [ { "description": "Alert version IDs to filter events by", "in": "query", "name": "alert_ids", "required": true, "schema": { "description": "Alert version IDs to filter events by", "examples": [ [ "32144a8a-7ee0-4c16-a093-2bf1f9c12e1e" ] ], "items": { "description": "Alert version IDs to filter events by", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, { "description": "Time range to search for events", "in": "query", "name": "timestamp_range", "required": true, "schema": { "properties": { "from": { "description": "Inclusive start of the time range.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "to": { "description": "Inclusive end of the time range.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "required": [ "from", "to" ], "title": "TimestampRange", "type": "object" } }, { "description": "Optional event labels to filter by (e.g., app, subsystem, region)", "in": "query", "name": "cx_event_labels", "required": false, "schema": { "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Optional event labels to filter by (e.g., app, subsystem, region)", "type": "object" } }, { "description": "Ordering criteria for the returned events.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "Ordering criteria for the returned events.", "items": { "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByDirection" } ], "examples": [ "ORDER_BY_DIRECTION_ASC" ] }, "fieldName": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByFields" } ], "examples": [ "ORDER_BY_FIELDS_TIMESTAMP" ] } }, "type": "object" }, "minItems": 0, "type": "array" } }, { "description": "Pagination parameters for the response.", "in": "query", "name": "pagination", "required": false, "schema": { "properties": { "pageSize": { "description": "Maximum number of results to return per page.", "examples": [ 10 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Opaque token for fetching the next page of results.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertEventsResponse" } } }, "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 Alert Events", "tags": [ "Events Service" ] } }, "/alerts/alerts/v3/all/replace": { "put": { "description": "Replaces multiple alert definitions in a single request. Each entry updates the existing alert definition with the matching ID; alert definitions not referenced in the request are left unchanged. The operation is best-effort - entries that fail are reported in the response and do not prevent other entries from being applied. Limited to 100 alert definitions per request.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_BulkReplaceAlertDefs", "requestBody": { "content": { "application/json": { "schema": { "description": "A request to bulk replace multiple alert definitions", "properties": { "alertDefsToReplace": { "description": "List of alert definitions to replace. Limited to 100 alert definitions per request.", "items": { "$ref": "#/components/schemas/AlertDefToReplace" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "title": "Bulk replace alert definitions request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkReplaceAlertDefsResponse" } } }, "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": "Bulk replace alert definitions", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] } }, "/alerts/alerts/v3/version-ids/{alert_version_id}": { "get": { "description": "Returns the alert definition with the specified version ID.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertDefsService_GetAlertDefByVersionId", "parameters": [ { "description": "Alert version ID", "in": "path", "name": "alert_version_id", "required": true, "schema": { "description": "Alert version ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "maxLength": 36, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "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.", "in": "query", "name": "include_access_permissions", "required": false, "schema": { "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.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAlertDefByVersionIdResponse" } } }, "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 alert definition by alert version ID", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] } }, "/alerts/alerts/v3/{id}": { "get": { "description": "Returns the details of the specified alert definition.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertDefsService_GetAlertDef", "parameters": [ { "description": "Alert definition ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Alert definition ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true } }, { "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.", "in": "query", "name": "include_access_permissions", "required": false, "schema": { "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.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAlertDefResponse" } } }, "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 alert definition by ID", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] }, "delete": { "description": "Deletes the alert definition with the specified ID.\n\nRequires the following permissions:\n- `alerts:UpdateConfig`", "operationId": "AlertDefsService_DeleteAlertDef", "parameters": [ { "description": "The unique identifier of the alert definition to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the alert definition to delete.", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAlertDefResponse" } } }, "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": "DeleteAlertDef", "tags": [ "Alert definitions service" ], "x-coralogixPermissions": [ "alerts:UpdateConfig" ] } }, "/alerts/events/v3": { "get": { "description": "Returns a list of alert events matching the specified filters.", "operationId": "EventsService_ListEvents", "parameters": [ { "description": "Filter criteria for events.", "in": "query", "name": "filter", "required": true, "schema": { "properties": { "cxEventKeys": { "description": "List of event attribute keys to include when retrieving event data.", "examples": [ [ "test_key" ] ], "items": { "description": "List of event attribute keys to include when retrieving event data.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "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": { "description": "List of event type identifiers to include in the results.", "examples": [ [ "test_type" ] ], "items": { "description": "List of event type identifiers to include in the results.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/TimestampRange" } ], "description": "Time range to filter events by their occurrence timestamp." } }, "required": [ "timestamp", "cxEventTypes", "cxEventKeys" ], "title": "EventsFilter", "type": "object" } }, { "description": "Pagination parameters for the response.", "in": "query", "name": "pagination", "required": true, "schema": { "properties": { "pageSize": { "description": "Maximum number of results to return per page.", "examples": [ 10 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Opaque token for fetching the next page of results.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "type": "object" } }, { "description": "Ordering criteria for the returned events.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "Ordering criteria for the returned events.", "items": { "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByDirection" } ], "examples": [ "ORDER_BY_DIRECTION_ASC" ] }, "fieldName": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByFields" } ], "examples": [ "ORDER_BY_FIELDS_TIMESTAMP" ] } }, "type": "object" }, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v3.ListEventsResponse" } } }, "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 Events", "tags": [ "Events Service" ] } }, "/alerts/events/v3/all/count": { "get": { "description": "Returns the count of alert events matching the given filters.", "operationId": "EventsService_ListEventsCount", "parameters": [ { "description": "Filter criteria for events.", "in": "query", "name": "filter", "required": true, "schema": { "properties": { "cxEventKeys": { "description": "List of event attribute keys to include when retrieving event data.", "examples": [ [ "test_key" ] ], "items": { "description": "List of event attribute keys to include when retrieving event data.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "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": { "description": "List of event type identifiers to include in the results.", "examples": [ [ "test_type" ] ], "items": { "description": "List of event type identifiers to include in the results.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/TimestampRange" } ], "description": "Time range to filter events by their occurrence timestamp." } }, "required": [ "timestamp", "cxEventTypes", "cxEventKeys" ], "title": "EventsFilter", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEventsCountResponse" } } }, "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 Events Count", "tags": [ "Events Service" ] } }, "/alerts/events/v3/all/list": { "get": { "description": "Returns a list of alert events matching the given filters.", "operationId": "EventsService_BatchGetEvent", "parameters": [ { "description": "The ids.", "in": "query", "name": "ids", "required": false, "schema": { "description": "The ids.", "items": { "description": "The ids.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, { "description": "Ordering criteria for the returned events.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "Ordering criteria for the returned events.", "items": { "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByDirection" } ], "examples": [ "ORDER_BY_DIRECTION_ASC" ] }, "fieldName": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByFields" } ], "examples": [ "ORDER_BY_FIELDS_TIMESTAMP" ] } }, "type": "object" }, "minItems": 0, "type": "array" } }, { "description": "Pagination parameters for the response.", "in": "query", "name": "pagination", "required": false, "schema": { "properties": { "pageSize": { "description": "Maximum number of results to return per page.", "examples": [ 10 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Opaque token for fetching the next page of results.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "type": "object" } }, { "description": "Optional filter to narrow the set of returned events.", "in": "query", "name": "filter", "required": false, "schema": { "properties": { "timestamp": { "allOf": [ { "$ref": "#/components/schemas/TimestampRange" } ], "description": "Time range to filter events by their occurrence timestamp." } }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetEventResponse" } } }, "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": "Batch Get Event", "tags": [ "Events Service" ] } }, "/alerts/events/v3/all/statistics": { "get": { "description": "Returns statistical aggregates for alert events.", "operationId": "EventsService_GetEventsStatistics", "parameters": [ { "description": "Filter criteria for events.", "in": "query", "name": "filter", "required": true, "schema": { "properties": { "cxEventKeys": { "description": "List of event attribute keys to include when retrieving event data.", "examples": [ [ "test_key" ] ], "items": { "description": "List of event attribute keys to include when retrieving event data.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "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": { "description": "List of event type identifiers to include in the results.", "examples": [ [ "test_type" ] ], "items": { "description": "List of event type identifiers to include in the results.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/TimestampRange" } ], "description": "Time range to filter events by their occurrence timestamp." } }, "required": [ "timestamp", "cxEventTypes", "cxEventKeys" ], "title": "EventsFilter", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventsStatisticsResponse" } } }, "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 Events Statistics", "tags": [ "Events Service" ] } }, "/alerts/events/v3/{id}": { "get": { "description": "Returns the alert event with the specified ID.", "operationId": "EventsService_GetEvent", "parameters": [ { "description": "Unique identifier of the alert event to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the alert event to retrieve.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, { "description": "The order bys.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "The order bys.", "items": { "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByDirection" } ], "examples": [ "ORDER_BY_DIRECTION_ASC" ] }, "fieldName": { "allOf": [ { "$ref": "#/components/schemas/events.v3.OrderByFields" } ], "examples": [ "ORDER_BY_FIELDS_TIMESTAMP" ] } }, "type": "object" }, "minItems": 0, "type": "array" } }, { "description": "Pagination parameters for the response.", "in": "query", "name": "pagination", "required": false, "schema": { "properties": { "pageSize": { "description": "Maximum number of results to return per page.", "examples": [ 10 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Opaque token for fetching the next page of results.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v3.GetEventResponse" } } }, "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 Event", "tags": [ "Events Service" ] } }, "/alerts/suppression-rules/v1": { "get": { "description": "Returns alert suppression rules with optional pagination.", "operationId": "AlertSchedulerRuleService_GetBulkAlertSchedulerRule", "parameters": [ { "description": "Active timeframe filter to limit results to rules active in the given window.", "in": "query", "name": "active_timeframe", "required": false, "schema": { "properties": { "endTime": { "description": "End time.", "minLength": 0, "type": "string" }, "startTime": { "description": "Start time.", "minLength": 0, "type": "string" }, "timezone": { "description": "Timezone.", "minLength": 0, "type": "string" } }, "type": "object" } }, { "description": "Whether this resource is enabled.", "in": "query", "name": "enabled", "required": false, "schema": { "description": "Whether this resource is enabled.", "type": "boolean", "x-coralogix-presence": true } }, { "description": "Filter results to the specified alert scheduler rule or rule version IDs.", "in": "query", "name": "alert_scheduler_rules_ids", "required": false, "schema": { "oneOf": [ { "required": [ "alertSchedulerIds" ], "type": "object" }, { "required": [ "alertSchedulerVersionIds" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "alertSchedulerIds" ], "type": "object" }, { "required": [ "alertSchedulerVersionIds" ], "type": "object" } ] }, "type": "object" } ], "properties": { "alertSchedulerIds": { "description": "Alert scheduler rule ids.", "properties": { "alertSchedulerRuleIds": { "description": "List of alert scheduler rule IDs.", "items": { "description": "List of alert scheduler rule IDs.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object" }, "alertSchedulerVersionIds": { "description": "Alert scheduler rule version ids.", "properties": { "alertSchedulerRuleVersionIds": { "description": "The alert scheduler rule version ids.", "items": { "description": "The alert scheduler rule version ids.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } }, "type": "object" } }, "type": "object" } }, { "description": "Token for fetching the next page of results.", "in": "query", "name": "next_page_token", "required": false, "schema": { "description": "Token for fetching the next page of results.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkAlertSchedulerRuleResponse" } } }, "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 multiple alert scheduler rules", "tags": [ "Alert Scheduler Rule service" ] }, "put": { "description": "Updates an existing alert suppression rule.", "operationId": "AlertSchedulerRuleService_UpdateAlertSchedulerRule", "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request sent to update an alert scheduler rule", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "required": [ "alertSchedulerRule" ], "title": "Update alert scheduler rule request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAlertSchedulerRuleResponse" } } }, "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 an alert scheduler rule", "tags": [ "Alert Scheduler Rule service" ] }, "post": { "description": "Creates a new alert suppression rule.", "operationId": "AlertSchedulerRuleService_CreateAlertSchedulerRule", "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request sent to create an alert scheduler rule", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "required": [ "alertSchedulerRule" ], "title": "Create alert scheduler rule request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAlertSchedulerRuleResponse" } } }, "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": "Create an alert scheduler rule", "tags": [ "Alert Scheduler Rule service" ] } }, "/alerts/suppression-rules/v1/all/rules": { "put": { "description": "Replaces all alert suppression rules with the provided set.", "operationId": "AlertSchedulerRuleService_UpdateBulkAlertSchedulerRule", "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request sent to update multiple alert scheduler rules", "properties": { "updateAlertSchedulerRuleRequests": { "description": "The update alert scheduler rule requests.", "items": { "$ref": "#/components/schemas/UpdateAlertSchedulerRuleRequest" }, "minItems": 0, "type": "array" } }, "required": [ "updateAlertSchedulerRuleRequests" ], "title": "Update bulk alert scheduler rule request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBulkAlertSchedulerRuleResponse" } } }, "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 multiple alert scheduler rules", "tags": [ "Alert Scheduler Rule service" ] }, "post": { "description": "Returns all alert suppression rules matching the given criteria.", "operationId": "AlertSchedulerRuleService_CreateBulkAlertSchedulerRule", "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request sent to create multiple alert scheduler rules", "properties": { "createAlertSchedulerRuleRequests": { "description": "The create alert scheduler rule requests.", "items": { "$ref": "#/components/schemas/CreateAlertSchedulerRuleRequest" }, "minItems": 0, "type": "array" } }, "required": [ "createAlertSchedulerRuleRequests" ], "title": "Create bulk alert scheduler rule request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkAlertSchedulerRuleResponse" } } }, "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": "Create multiple alert scheduler rules", "tags": [ "Alert Scheduler Rule service" ] } }, "/alerts/suppression-rules/v1/{alert_scheduler_rule_id}": { "get": { "description": "Returns the details of the specified alert suppression rule.", "operationId": "AlertSchedulerRuleService_GetAlertSchedulerRule", "parameters": [ { "description": "The unique identifier of the alert scheduler (suppression) rule.", "in": "path", "name": "alert_scheduler_rule_id", "required": true, "schema": { "description": "The unique identifier of the alert scheduler (suppression) rule.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAlertSchedulerRuleResponse" } } }, "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 an alert scheduler rule", "tags": [ "Alert Scheduler Rule service" ] }, "delete": { "description": "Deletes the alert suppression rule with the specified ID.", "operationId": "AlertSchedulerRuleService_DeleteAlertSchedulerRule", "parameters": [ { "description": "The unique identifier of the alert scheduler (suppression) rule to delete.", "in": "path", "name": "alert_scheduler_rule_id", "required": true, "schema": { "description": "The unique identifier of the alert scheduler (suppression) rule to delete.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAlertSchedulerRuleResponse" } } }, "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": "Delete an alert scheduler rule", "tags": [ "Alert Scheduler Rule service" ] } }, "/cases/acknowledged/v1": { "post": { "description": "Mark multiple cases as acknowledged in a single operation.\n\nRequires the following permissions:\n- `case:Acknowledge`", "operationId": "CasesService_BulkAcknowledge", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to acknowledge multiple cases", "properties": { "actor": { "allOf": [ { "$ref": "#/components/schemas/cases.v1.UserDetails" } ], "description": "User performing the acknowledgment" }, "ids": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "required": [ "ids", "actor" ], "title": "Bulk acknowledge request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAcknowledgeResponse" } } }, "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": "Acknowledge multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Acknowledge" ] } }, "/cases/acknowledged/v1/{id}": { "put": { "description": "Mark the case as acknowledged by a user.\n\nRequires the following permissions:\n- `case:Acknowledge`", "operationId": "CasesService_AcknowledgeCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeCaseResponse" } } }, "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": "Acknowledge a case", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Acknowledge" ] }, "delete": { "description": "Remove the acknowledgment from a case.\n\nRequires the following permissions:\n- `case:Acknowledge`", "operationId": "CasesService_UnacknowledgeCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnacknowledgeCaseResponse" } } }, "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": "Unacknowledge a case", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Acknowledge" ] } }, "/cases/assigned/v1": { "put": { "description": "Assign multiple cases to a specific user in a single operation.\n\nRequires the following permissions:\n- `case:Assign`", "operationId": "CasesService_BulkAssign", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to assign multiple cases to a user", "properties": { "assignee": { "allOf": [ { "$ref": "#/components/schemas/cases.v1.UserDetails" } ], "description": "User to assign the cases to" }, "ids": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "required": [ "ids", "assignee" ], "title": "Bulk assign request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAssignResponse" } } }, "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": "Assign multiple cases to a user", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Assign" ] }, "delete": { "description": "Remove the current assignee from multiple cases in a single operation.\n\nRequires the following permissions:\n- `case:Assign`", "operationId": "CasesService_BulkUnassign", "parameters": [ { "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`).", "in": "query", "name": "ids", "required": false, "schema": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUnassignResponse" } } }, "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": "Remove assignment from multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Assign" ] } }, "/cases/assigned/v1/{id}": { "post": { "description": "Assign a case to a specific user.\n\nRequires the following permissions:\n- `case:Assign`", "operationId": "CasesService_AssignCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to assign a case to a specific user.", "properties": { "assignee": { "allOf": [ { "$ref": "#/components/schemas/cases.v1.UserDetails" } ], "description": "User to assign the case to" } }, "required": [ "assignee" ], "title": "Assign case request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignCaseResponse" } } }, "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": "Assign a case to a user", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Assign" ] }, "delete": { "description": "Remove the current assignee from a case.\n\nRequires the following permissions:\n- `case:Assign`", "operationId": "CasesService_UnassignCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignCaseResponse" } } }, "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": "Remove case assignment", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Assign" ] } }, "/cases/cases/case-settings/v1/configs": { "post": { "description": "Create a new case settings team configuration with an optional display name and settings.\n\nRequires the following permissions:\n- `case-config:Update`", "operationId": "CaseSettingsService_CreateCaseSettings", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new case settings team configuration.", "properties": { "caseLifecycle": { "allOf": [ { "$ref": "#/components/schemas/CaseLifecycle" } ], "description": "Case lifecycle settings for the team" }, "globalIndicatorSettings": { "allOf": [ { "$ref": "#/components/schemas/GlobalIndicatorSettings" } ], "description": "Configuration settings" }, "name": { "description": "Optional display name for the case settings team configuration", "examples": [ "Primary Case Settings" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "globalIndicatorSettings" ], "title": "Create case settings request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCaseSettingsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create a case settings team configuration", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Update" ] } }, "/cases/cases/case-settings/v1/configs/{id}": { "get": { "description": "Retrieve a single case settings team configuration by its identifier.\n\nRequires the following permissions:\n- `case-config:Read`", "operationId": "CaseSettingsService_GetCaseSettings", "parameters": [ { "description": "ID of the case settings team configuration", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the case settings team configuration", "examples": [ "8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCaseSettingsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Case settings not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get a case settings team configuration", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Read" ] }, "delete": { "description": "Delete a case settings team configuration by its identifier.\n\nRequires the following permissions:\n- `case-config:Update`", "operationId": "CaseSettingsService_DeleteCaseSettings", "parameters": [ { "description": "ID of the case settings team configuration to delete", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the case settings team configuration to delete", "examples": [ "8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCaseSettingsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Case settings not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete a case settings team configuration", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Update" ] }, "patch": { "description": "Update the display name and/or settings of an existing case settings team configuration.\n\nRequires the following permissions:\n- `case-config:Update`", "operationId": "CaseSettingsService_UpdateCaseSettings", "parameters": [ { "description": "ID of the case settings team configuration to update", "in": "path", "name": "id", "required": true, "schema": { "description": "ID of the case settings team configuration to update", "examples": [ "8c0c02a3-3c1c-4d56-9a2d-9f6ab6a4b321" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to update an existing case settings team configuration.", "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" }, "name": { "description": "New display name for the case settings team configuration", "examples": [ "SRE Case Settings" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Update case settings request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCaseSettingsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Case settings not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update a case settings team configuration", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Update" ] } }, "/cases/cases/case-settings/v1/configs:getActive": { "get": { "description": "Retrieve the currently active case settings team configuration (after any org- or user-level precedence resolution).\n\nRequires the following permissions:\n- `case-config:Read`", "operationId": "CaseSettingsService_GetActiveCaseSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActiveCaseSettingsResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Active team config not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get the active case settings team configuration", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Read" ] } }, "/cases/cases/case-settings/v1/configs:getSystemDefaults": { "get": { "description": "Retrieve the platform-wide default settings for case settings team configurations.\n\nRequires the following permissions:\n- `case-config:Read`", "operationId": "CaseSettingsService_GetSystemDefaultCaseSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSystemDefaultCaseSettingsResponse" } } }, "description": "" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized request" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get system default case settings team configuration settings", "tags": [ "Case Settings service" ], "x-coralogixPermissions": [ "case-config:Read" ] } }, "/cases/cases/v1": { "post": { "description": "List cases using filters, pagination and custom ordering.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_ListCases", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to list cases with filtering and pagination", "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" } }, "title": "List cases request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCasesResponse" } } }, "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 cases with filters", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/cases/v1/{case_id}/comments": { "post": { "description": "Create a new comment event for a case.\n\nRequires the following permissions:\n- `case:Comment`", "operationId": "CaseEventsService_CreateComment", "parameters": [ { "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`).", "in": "path", "name": "case_id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request for creating a comment on a case.", "properties": { "attachments": { "description": "Attachments to the comment", "items": { "$ref": "#/components/schemas/CommentAttachment" }, "maxItems": 100, "minItems": 0, "type": "array" }, "text": { "description": "Comment text to update. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "This is updated text" ], "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string" } }, "required": [ "text" ], "title": "Create comment event request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create a comment event", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Comment" ] } }, "/cases/cases/v1/{case_id}/deep-links": { "get": { "description": "Retrieve deep-link URLs for a case.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_GetCaseDeepLinks", "parameters": [ { "$ref": "#/components/parameters/case_id" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCaseDeepLinksResponse" } } }, "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 case deep links", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/cases/v1/{case_id}/events": { "get": { "description": "Retrieve all events associated with a specific case.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CaseEventsService_ListEvents", "parameters": [ { "$ref": "#/components/parameters/case_id" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.ListEventsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "List events for a case", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/cases/v1/{case_id}/sync-external-thread-comments": { "post": { "description": "Synchronize events from an external source (e.g. Slack) into the case.\n\nRequires the following permissions:\n- `case:Comment`", "operationId": "CaseEventsService_SyncExternalCaseEvents", "parameters": [ { "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`).", "in": "path", "name": "case_id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncExternalCaseEventsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Case not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Sync external Case events", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Comment" ] } }, "/cases/cases/v1/{id}": { "get": { "description": "Retrieve detailed information about a single case by its unique identifier.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_GetCase", "parameters": [ { "$ref": "#/components/parameters/id_3" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCaseResponse" } } }, "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 case by ID", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] }, "put": { "description": "Apply a partial update (patch) to a case.\n\nRequires the following permissions:\n- `case:Update`", "operationId": "CasesService_UpdateCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Partial set of fields to update on the case", "properties": { "resolutionReason": { "description": "New case resolution reason. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "False alarm" ], "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "title": { "description": "New case title. Leading and trailing whitespace is trimmed before the length limits are applied. A title longer than 512 characters is truncated to 512 characters, ending with \"…\".", "examples": [ "Database connection investigation" ], "maxLength": 512, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Case patch", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCaseResponse" } } }, "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 case fields", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Update" ] } }, "/cases/closed/v1": { "post": { "description": "Close multiple cases in a single operation.\n\nRequires the following permissions:\n- `case:Close`", "operationId": "CasesService_BulkClose", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to close multiple cases", "properties": { "ids": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "required": [ "ids" ], "title": "Bulk close request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCloseResponse" } } }, "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": "Close multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Close" ] } }, "/cases/closed/v1/{id}": { "post": { "description": "Close a case that no longer requires action.\n\nRequires the following permissions:\n- `case:Close`", "operationId": "CasesService_CloseCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseCaseResponse" } } }, "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": "Close a case", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Close" ] } }, "/cases/events/v1/{event_id}": { "get": { "description": "Retrieve a single event by its unique identifier.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CaseEventsService_GetEvent", "parameters": [ { "description": "ID of the event to fetch", "in": "path", "name": "event_id", "required": true, "schema": { "description": "ID of the event to fetch", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.GetEventResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Event not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get an event by ID", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/events/v1/{event_id}/comments": { "put": { "description": "Modify the content of an existing comment event.\n\nRequires the following permissions:\n- `case:Comment`", "operationId": "CaseEventsService_UpdateComment", "parameters": [ { "description": "ID of the comment event to update", "in": "path", "name": "event_id", "required": true, "schema": { "description": "ID of the comment event to update", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request for updating a comment on a case event.", "properties": { "attachments": { "description": "Attachments to the comment", "items": { "$ref": "#/components/schemas/CommentAttachment" }, "maxItems": 100, "minItems": 0, "type": "array" }, "text": { "description": "Comment text to update. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "This is updated text" ], "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string" } }, "required": [ "text" ], "title": "Update comment event request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCommentResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Event not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update a comment event", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Comment" ] }, "delete": { "description": "Delete an existing comment event from a case.\n\nRequires the following permissions:\n- `case:Comment`", "operationId": "CaseEventsService_DeleteComment", "parameters": [ { "description": "ID of the comment event to delete", "in": "path", "name": "event_id", "required": true, "schema": { "description": "ID of the comment event to delete", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ], "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" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCommentResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Event not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete a comment event", "tags": [ "Case Events service" ], "x-coralogixPermissions": [ "case:Comment" ] } }, "/cases/filter-values/v1": { "post": { "description": "Retrieve available filter and aggregation values for cases.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_GetFilterValues", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to retrieve available filter and aggregation values for cases.", "properties": { "filters": { "allOf": [ { "$ref": "#/components/schemas/CaseFilters" } ], "description": "Filters to apply when computing available values" } }, "title": "Get case filter values request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cases.v1.GetFilterValuesResponse" } } }, "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 available filter values", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/grouping-keys/v1": { "get": { "description": "Retrieve all available grouping keys that can be used for organizing and filtering Cases.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_GetGroupingKeys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGroupingKeysResponse" } } }, "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 available grouping keys", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/indicators/v1/get": { "post": { "description": "Retrieve a case by its source indicator. Currently supports Prometheus AlertManager alerts identified by fingerprint and start time.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesService_GetCaseByIndicator", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to retrieve a case associated with a given alert indicator.", "properties": { "prometheusAlert": { "$ref": "#/components/schemas/PrometheusAlertManagerIndicator" } }, "title": "Get case by indicator request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "case": { "category": "CASE_CATEGORY_AVAILABILITY", "createTime": "2025-09-22T10:30:00.000Z", "groupings": [], "id": "3f166e9f-3c88-4af2-b52e-138f339dab3e", "impactedEntities": [], "labels": [], "priority": "CASE_PRIORITY_P2", "status": "CASE_STATUS_ACKNOWLEDGED", "title": "Database outage investigation" } }, "schema": { "$ref": "#/components/schemas/GetCaseByIndicatorResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get case by indicator", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/notifications/v1/deliveries": { "post": { "description": "Retrieve notification delivery records for one or more cases, including routing, target, and outcome information.\n\nRequires the following permissions:\n- `case:Read`", "operationId": "CasesNotificationService_ListNotificationDeliveries", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to retrieve notification delivery records for one or more cases.", "properties": { "caseIds": { "description": "Case IDs to retrieve notification deliveries for", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] ], "items": { "description": "Case IDs to retrieve notification deliveries for", "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "required": [ "caseIds" ], "title": "List notification deliveries request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNotificationDeliveriesResponse" } } }, "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 notification deliveries for cases", "tags": [ "Cases notification service" ], "x-coralogixPermissions": [ "case:Read" ] } }, "/cases/priority-override/v1": { "post": { "description": "Override the priority with for multiple cases in a single operation.\n\nRequires the following permissions:\n- `case:Update`", "operationId": "CasesService_BulkSetPriorityOverride", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to override priority for multiple cases", "properties": { "ids": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" }, "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Priority value to override with", "examples": [ "CASE_PRIORITY_P3" ] } }, "required": [ "ids", "priority" ], "title": "Bulk override priority request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSetPriorityOverrideResponse" } } }, "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": "Override priority for multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Update" ] }, "delete": { "description": "Remove previously set priority overrides from multiple cases in a single operation.\n\nRequires the following permissions:\n- `case:Update`", "operationId": "CasesService_BulkClearPriorityOverride", "parameters": [ { "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`).", "in": "query", "name": "ids", "required": false, "schema": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkClearPriorityOverrideResponse" } } }, "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": "Remove priority override from multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Update" ] } }, "/cases/priority-override/v1/{id}": { "put": { "description": "Override a case's computed priority with a specific value.\n\nRequires the following permissions:\n- `case:Update`", "operationId": "CasesService_SetPriorityOverride", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to override a case's computed priority with a specific value.", "properties": { "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Priority value to override with", "examples": [ "CASE_PRIORITY_P1" ] } }, "required": [ "priority" ], "title": "Set priority override request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPriorityOverrideResponse" } } }, "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": "Set priority override", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Update" ] }, "delete": { "description": "Remove a previously set priority override for a case.\n\nRequires the following permissions:\n- `case:Update`", "operationId": "CasesService_ClearPriorityOverride", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearPriorityOverrideResponse" } } }, "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": "Remove priority override", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Update" ] }, "parameters": [ { "$ref": "#/components/parameters/id_3" } ] }, "/cases/resolved/v1": { "post": { "description": "Resolve multiple cases in a single operation.\n\nRequires the following permissions:\n- `case:Close`", "operationId": "CasesService_BulkResolve", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to resolve multiple cases", "properties": { "ids": { "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`).", "examples": [ [ "3f166e9f-3c88-4af2-b52e-138f339dab3e", "CASE-123" ] ], "items": { "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`).", "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" }, "maxItems": 1000, "minItems": 1, "type": "array" }, "reason": { "description": "Reason for resolution", "examples": [ "These cases are no longer active." ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "ids" ], "title": "Bulk resolve request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkResolveResponse" } } }, "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": "Resolve multiple cases", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Close" ] } }, "/cases/resolved/v1/{id}": { "put": { "description": "Mark a case as resolved.\n\nRequires the following permissions:\n- `case:Close`", "operationId": "CasesService_ResolveCase", "parameters": [ { "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`).", "in": "path", "name": "id", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ], "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to mark a case as resolved.", "properties": { "reason": { "description": "Reason to resolve", "examples": [ "This case is not applicable." ], "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Resolve case request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveCaseResponse" } } }, "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": "Resolve a case", "tags": [ "Cases service" ], "x-coralogixPermissions": [ "case:Close" ] } }, "/dashboards/check/v1": { "post": { "description": "Checks a dashboard definition or an existing dashboard by id and returns validation issues without persisting changes.\n\nRequires the following permissions:\n- `team-dashboards:Read`", "operationId": "DashboardsService_CheckDashboard", "requestBody": { "content": { "application/json": { "schema": { "description": "Validate a dashboard definition or an existing dashboard by id", "oneOf": [ { "required": [ "dashboard" ], "type": "object" }, { "required": [ "dashboardId" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "dashboard" ], "type": "object" }, { "required": [ "dashboardId" ], "type": "object" } ] }, "type": "object" } ], "properties": { "dashboard": { "allOf": [ { "$ref": "#/components/schemas/Dashboard" } ], "description": "Dashboard definition to validate" }, "dashboardId": { "description": "Id of an existing dashboard to load and validate", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "requestId": { "description": "Optional idempotency key for the check request", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Check dashboard request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "issues": [ { "location": "/sections/0/rows/1/widgets/2", "message": "Widget 'cpu-chart' references undefined variable 'env'", "severity": "SEVERITY_ERROR" }, { "location": "/sections/1/rows/0/widgets/0/queries/0", "message": "Query uses deprecated function 'timeShift'", "severity": "SEVERITY_WARNING" } ] }, "schema": { "$ref": "#/components/schemas/CheckDashboardResponse" } } }, "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": "Validate a dashboard and return issues", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read" ] } }, "/dashboards/dashboards/v1": { "put": { "description": "Replaces the dashboard definition, the access policy, or both. Sending `dashboard` requires `team-dashboards:Update`. Changing the access policy requires `team-dashboards:UpdateAccessPolicy` together with `team-dashboards:Update` on the same dashboard, or the break-glass `access-policies:UpdateAll`. Without that, an `accessPolicy` that differs from the stored policy is rejected with `403` and nothing in the request is stored; one equal to the stored policy is accepted and leaves it unchanged. Policies are compared as JSON, so formatting alone is not a change. A request that sends only `accessPolicy` creates no new dashboard version.\n\nRequires the following permissions:\n- `team-dashboards:Update`\n- `team-dashboards:UpdateAccessPolicy`\n- `access-policies:UpdateAll`", "operationId": "DashboardsService_ReplaceDashboard", "requestBody": { "content": { "application/json": { "schema": { "description": "Replaces the dashboard definition, the access policy, or both. A part that is present replaces the stored value as a whole; a part that is omitted is left unchanged. At least one of `dashboard` and `accessPolicy` is required.", "properties": { "accessPolicy": { "description": "JSON string with the access policy of this dashboard, which defines granular permissions for users and groups. Changing it requires `team-dashboards:UpdateAccessPolicy` together with `team-dashboards:Update` on this dashboard, or the break-glass `access-policies:UpdateAll`. Without that, a value that differs from the stored policy is rejected with `403`, and the stored policy sent back unchanged is accepted.", "examples": [ "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}" ], "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dashboard": { "allOf": [ { "$ref": "#/components/schemas/Dashboard" } ], "description": "The complete dashboard definition to store. Requires `team-dashboards:Update`." }, "dashboardId": { "description": "The id of the dashboard to change. Required when `dashboard` is omitted; when sent together with `dashboard` it must equal `dashboard.id`.", "examples": [ "GZLHSeqelCbD3I7HbIDtL" ], "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isLocked": { "description": "Whether the dashboard is locked against edits. Ignored when `dashboard` is omitted.", "type": "boolean", "x-coralogix-presence": true }, "requestId": { "description": "Idempotency key for the replace request, used to prevent duplicate updates.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "requestId" ], "title": "Replace dashboard request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDashboardResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Dashboard not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Replace a dashboard", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Update", "team-dashboards:UpdateAccessPolicy", "access-policies:UpdateAll" ] }, "post": { "description": "Creates a new dashboard.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardsService_CreateDashboard", "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request used to create a new custom dashboard", "properties": { "accessPolicy": { "description": "JSON string representing the access policy for this dashboard. Defines granular permissions for users and groups.", "examples": [ "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}" ], "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dashboard": { "$ref": "#/components/schemas/Dashboard" }, "isLocked": { "description": "The is locked.", "type": "boolean", "x-coralogix-presence": true }, "requestId": { "description": "The request id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "requestId", "dashboard" ], "title": "Create dashboard request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDashboardResponse" } } }, "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": "Create a new dashboard", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] } }, "/dashboards/dashboards/v1/catalog/list": { "get": { "description": "Returns the dashboards the caller may access. A caller with `team-dashboards:Read` receives every dashboard it may view. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own, so a dashboard for which the caller holds only `team-dashboards:ReadAccessPolicy` is not listed. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives every dashboard, each reduced to `id`, `name`, `slugName`, `folder`, `isLocked` and `permissions`.\n\nRequires the following permissions:\n- `team-dashboards:Read`\n- `team-dashboards:ReadAccessPolicy`\n- `access-policies:ReadAll`", "operationId": "DashboardCatalogService_GetDashboardCatalog", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDashboardCatalogResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get dashboard catalog", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read", "team-dashboards:ReadAccessPolicy", "access-policies:ReadAll" ] } }, "/dashboards/dashboards/v1/slugs/lookup/{slug}": { "get": { "description": "Returns the dashboard associated with the specified slug. A caller with `team-dashboards:Read` on this dashboard receives the dashboard definition and its metadata, and the access policy too if it also holds `team-dashboards:ReadAccessPolicy` on this dashboard. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own: a caller that holds it without `team-dashboards:Read` and without `access-policies:ReadAll` gets `403`. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives only the access policy, the lock state and the `permissions` object.\n\nRequires the following permissions:\n- `team-dashboards:Read`\n- `team-dashboards:ReadAccessPolicy`\n- `access-policies:ReadAll`", "operationId": "DashboardsService_GetDashboardBySlug", "parameters": [ { "description": "The URL slug identifying the dashboard to retrieve.", "in": "path", "name": "slug", "required": true, "schema": { "description": "The URL slug identifying the dashboard to retrieve.", "maxLength": 255, "minLength": 1, "pattern": "^[a-z0-9]+(?:[-_]+[a-z0-9]+)*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDashboardBySlugResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Dashboard not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get a dashboard by URL slug", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read", "team-dashboards:ReadAccessPolicy", "access-policies:ReadAll" ] } }, "/dashboards/dashboards/v1/{dashboard_id}": { "get": { "description": "Returns the details of the specified dashboard. A caller with `team-dashboards:Read` on this dashboard receives the dashboard definition and its metadata, and the access policy too if it also holds `team-dashboards:ReadAccessPolicy` on this dashboard. `team-dashboards:ReadAccessPolicy` requires `team-dashboards:Read` on the same dashboard and grants nothing on its own: a caller that holds it without `team-dashboards:Read` and without `access-policies:ReadAll` gets `403`. Only `access-policies:ReadAll` is break-glass: a caller without `team-dashboards:Read` who holds it receives only the access policy, the lock state and the `permissions` object.\n\nRequires the following permissions:\n- `team-dashboards:Read`\n- `team-dashboards:ReadAccessPolicy`\n- `access-policies:ReadAll`", "operationId": "DashboardsService_GetDashboard", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDashboardResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Dashboard not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get a dashboard", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read", "team-dashboards:ReadAccessPolicy", "access-policies:ReadAll" ] }, "delete": { "description": "Deletes the dashboard with the specified ID.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardsService_DeleteDashboard", "parameters": [ { "description": "Optional client-supplied request identifier used to correlate the deletion request.", "in": "query", "name": "request_id", "required": false, "schema": { "description": "Optional client-supplied request identifier used to correlate the deletion request.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDashboardResponse" } } }, "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": "Delete a dashboard", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] }, "parameters": [ { "$ref": "#/components/parameters/dashboard_id" } ] }, "/dashboards/dashboards/v1/{dashboard_id}/default": { "put": { "description": "Sets the specified dashboard as the default.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardsService_ReplaceDefaultDashboard", "parameters": [ { "$ref": "#/components/parameters/dashboard_id" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request to replace a default dashboard", "properties": { "requestId": { "description": "Idempotency key for the replace default dashboard request, used to prevent duplicate operations.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "requestId" ], "title": "Replace default dashboard request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDefaultDashboardResponse" } } }, "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": "Replace the default dashboard", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] } }, "/dashboards/dashboards/v1/{dashboard_id}/folder": { "post": { "description": "Assigns the dashboard to a folder.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardsService_AssignDashboardFolder", "parameters": [ { "$ref": "#/components/parameters/dashboard_id" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "This is a request for assigning a folder to a dashboard", "properties": { "folderId": { "description": "The ID of the folder to assign the dashboard to. Set to null to assign to the root folder.", "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", "x-coralogix-presence": true }, "requestId": { "description": "Idempotency key for the assign folder request, used to prevent duplicate operations.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "requestId" ], "title": "Assign dashboard to folder request data structure", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignDashboardFolderResponse" } } }, "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": "Assign a dashboard to a folder", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] } }, "/dashboards/folders/v1": { "get": { "description": "List all dashboard folders accessible.\n\nRequires the following permissions:\n- `team-dashboards:Read`", "operationId": "DashboardFoldersService_ListDashboardFolders", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDashboardFoldersResponse" } } }, "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 dashboard folders", "tags": [ "Dashboard folders service" ], "x-coralogixPermissions": [ "team-dashboards:Read" ] }, "put": { "description": "Replaces an existing dashboard folder.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardFoldersService_ReplaceDashboardFolder", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to replace an existing dashboard folder.", "properties": { "folder": { "allOf": [ { "$ref": "#/components/schemas/DashboardFolder" } ], "description": "The folder." }, "requestId": { "description": "Idempotency key for the replace folder request, used to prevent duplicate updates.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Replace dashboard folder request data structure", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceDashboardFolderResponse" } } }, "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": "Replace a dashboard folder", "tags": [ "Dashboard folders service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] }, "post": { "description": "Creates a new dashboard folder.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardFoldersService_CreateDashboardFolder", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new dashboard folder.", "properties": { "folder": { "allOf": [ { "$ref": "#/components/schemas/DashboardFolder" } ], "description": "The folder." }, "requestId": { "description": "The request id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Create dashboard folder request data structure", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDashboardFolderResponse" } } }, "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": "Create a dashboard folder", "tags": [ "Dashboard folders service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] } }, "/dashboards/folders/v1/{folder_id}": { "get": { "description": "Returns a dashboard folder data.\n\nRequires the following permissions:\n- `team-dashboards:Read`", "operationId": "DashboardFoldersService_GetDashboardFolder", "parameters": [ { "description": "Optional client-supplied request identifier used to correlate the get folder request.", "in": "query", "name": "request_id", "required": false, "schema": { "description": "Optional client-supplied request identifier used to correlate the get folder request.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDashboardFolderResponse" } } }, "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 a dashboard folder", "tags": [ "Dashboard folders service" ], "x-coralogixPermissions": [ "team-dashboards:Read" ] }, "delete": { "description": "Deletes the dashboard folder with the specified ID.\n\nRequires the following permissions:\n- `team-dashboards:Update`", "operationId": "DashboardFoldersService_DeleteDashboardFolder", "parameters": [ { "description": "Idempotency key for the delete folder request, used to prevent duplicate operations.", "in": "query", "name": "request_id", "required": false, "schema": { "description": "Idempotency key for the delete folder request, used to prevent duplicate operations.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDashboardFolderResponse" } } }, "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": "Delete a dashboard folder", "tags": [ "Dashboard folders service" ], "x-coralogixPermissions": [ "team-dashboards:Update" ] }, "parameters": [ { "name": "folder_id", "in": "path", "description": "The folder id.", "required": true, "schema": { "description": "The folder 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", "x-coralogix-presence": true } } ] }, "/dashboards/pinned/v1/{dashboard_id}": { "put": { "description": "Pins the specified dashboard.\n\nRequires the following permissions:\n- `team-dashboards:Read`", "operationId": "DashboardsService_PinDashboard", "parameters": [ { "description": "Idempotency key for the pin request, used to prevent duplicate operations.", "in": "query", "name": "request_id", "required": false, "schema": { "description": "Idempotency key for the pin request, used to prevent duplicate operations.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinDashboardResponse" } } }, "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": "Add dashboard to favorites", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read" ] }, "delete": { "description": "Unpins the specified dashboard.\n\nRequires the following permissions:\n- `team-dashboards:Read`", "operationId": "DashboardsService_UnpinDashboard", "parameters": [ { "description": "Idempotency key for the unpin request, used to prevent duplicate operations.", "in": "query", "name": "request_id", "required": false, "schema": { "description": "Idempotency key for the unpin request, used to prevent duplicate operations.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinDashboardResponse" } } }, "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": "Remove dashboard from favorites", "tags": [ "Dashboard service" ], "x-coralogixPermissions": [ "team-dashboards:Read" ] }, "parameters": [ { "$ref": "#/components/parameters/dashboard_id" } ] }, "/data-exploration/views/v1/folders": { "get": { "description": "List view's folders", "operationId": "ViewsFoldersService_ListViewFolders", "responses": { "200": { "content": { "application/json": { "example": { "folders": [ { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" } ] }, "schema": { "$ref": "#/components/schemas/ListViewFoldersResponse" } } }, "description": "" } }, "summary": "List view folders service", "tags": [ "Folders for views service" ] }, "put": { "description": "Replaces an existing view folder", "operationId": "ViewsFoldersService_ReplaceViewFolder", "requestBody": { "content": { "application/json": { "schema": { "description": "View folder.", "properties": { "id": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "name": { "description": "Folder name", "examples": [ "My Folder" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "id", "name" ], "title": "ViewFolder", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" }, "schema": { "$ref": "#/components/schemas/ViewFolder" } } }, "description": "" } }, "summary": "Replace View Folder service", "tags": [ "Folders for views service" ] }, "post": { "description": "Create view folder", "operationId": "ViewsFoldersService_CreateViewFolder", "requestBody": { "content": { "application/json": { "schema": { "description": "Create view folder.", "properties": { "name": { "description": "Folder name", "examples": [ "My Folder" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "name" ], "title": "CreateViewFolderRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" }, "schema": { "$ref": "#/components/schemas/ViewFolder" } } }, "description": "" } }, "summary": "Create View Folder service", "tags": [ "Folders for views service" ] } }, "/data-exploration/views/v1/folders/{id}": { "get": { "description": "Create view folder", "operationId": "ViewsFoldersService_GetViewFolder", "responses": { "200": { "content": { "application/json": { "example": { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" }, "schema": { "$ref": "#/components/schemas/ViewFolder" } } }, "description": "" } }, "summary": "Get View Folder service", "tags": [ "Folders for views service" ] }, "delete": { "description": "Deletes a view folder by ID", "operationId": "ViewsFoldersService_DeleteViewFolder", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteViewFolderResponse" } } }, "description": "" } }, "summary": "Delete View Folder service", "tags": [ "Folders for views service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier for folders", "required": true, "schema": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true } } ] }, "/data-exploration/views/v1/views": { "get": { "description": "Lists all company public views", "operationId": "ViewsService_ListViews", "responses": { "200": { "content": { "application/json": { "example": { "views": [ { "filters": { "filters": [ { "name": "applicationName", "selectedValues": { "demo": true } }, { "name": "subsystemName", "selectedValues": { "demo": true } }, { "name": "operationName", "selectedValues": { "demo": true } }, { "name": "serviceName", "selectedValues": { "demo": true } }, { "name": "severity", "selectedValues": { "demo": true } } ] }, "id": 52, "name": "Logs view", "searchQuery": { "query": "logs" }, "timeSelection": { "customSelection": { "fromTime": "2024-01-25T11:31:43.152Z", "toTime": "2024-01-25T11:37:13.238Z" } } } ] }, "schema": { "$ref": "#/components/schemas/ListViewsResponse" } } }, "description": "" } }, "summary": "List views service", "tags": [ "Views service" ] }, "post": { "description": "Creates a new view", "operationId": "ViewsService_CreateView", "requestBody": { "content": { "application/json": { "schema": { "description": "View folder.", "properties": { "filters": { "$ref": "#/components/schemas/SelectedFilters" }, "folderId": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "name": { "description": "View name", "examples": [ "Logs view" ], "maxLength": 250, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "searchQuery": { "allOf": [ { "$ref": "#/components/schemas/SearchQuery" } ], "description": "The search query." }, "timeSelection": { "$ref": "#/components/schemas/TimeSelection" }, "viewType": { "$ref": "#/components/schemas/ViewType", "default": "VIEW_TYPE_LOGS" } }, "required": [ "name", "timeSelection" ], "title": "ViewFolder", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "filters": { "filters": [ { "name": "applicationName", "selectedValues": { "demo": true } }, { "name": "subsystemName", "selectedValues": { "demo": true } }, { "name": "operationName", "selectedValues": { "demo": true } }, { "name": "serviceName", "selectedValues": { "demo": true } }, { "name": "severity", "selectedValues": { "demo": true } } ] }, "id": 52, "name": "Logs view", "searchQuery": { "query": "logs" }, "timeSelection": { "customSelection": { "fromTime": "2024-01-25T11:31:43.152Z", "toTime": "2024-01-25T11:37:13.238Z" } } }, "schema": { "$ref": "#/components/schemas/View" } } }, "description": "" } }, "summary": "Create a view service", "tags": [ "Views service" ] } }, "/data-exploration/views/v1/views/{id}": { "get": { "description": "Gets a view by ID", "operationId": "ViewsService_GetView", "responses": { "200": { "content": { "application/json": { "example": { "filters": { "filters": [ { "name": "applicationName", "selectedValues": { "demo": true } }, { "name": "subsystemName", "selectedValues": { "demo": true } }, { "name": "operationName", "selectedValues": { "demo": true } }, { "name": "serviceName", "selectedValues": { "demo": true } }, { "name": "severity", "selectedValues": { "demo": true } } ] }, "id": 52, "name": "Logs view", "searchQuery": { "query": "logs" }, "timeSelection": { "customSelection": { "fromTime": "2024-01-25T11:31:43.152Z", "toTime": "2024-01-25T11:37:13.238Z" } } }, "schema": { "$ref": "#/components/schemas/View" } } }, "description": "" } }, "summary": "Get view service", "tags": [ "Views service" ] }, "put": { "description": "Replaces an existing view", "operationId": "ViewsService_ReplaceView", "requestBody": { "content": { "application/json": { "schema": { "description": "Response for views.", "properties": { "filters": { "$ref": "#/components/schemas/SelectedFilters" }, "folderId": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "isCompactMode": { "default": false, "description": "Whether the view opens in compact mode. Create stores false, and a replace that omits the value stores false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "View name", "examples": [ "Logs view" ], "maxLength": 250, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "searchQuery": { "$ref": "#/components/schemas/SearchQuery" }, "timeSelection": { "$ref": "#/components/schemas/TimeSelection" }, "viewType": { "$ref": "#/components/schemas/ViewType" } }, "required": [ "name", "timeSelection" ], "title": "View", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "filters": { "filters": [ { "name": "applicationName", "selectedValues": { "demo": true } }, { "name": "subsystemName", "selectedValues": { "demo": true } }, { "name": "operationName", "selectedValues": { "demo": true } }, { "name": "serviceName", "selectedValues": { "demo": true } }, { "name": "severity", "selectedValues": { "demo": true } } ] }, "id": 52, "name": "Logs view", "searchQuery": { "query": "logs new" }, "timeSelection": { "customSelection": { "fromTime": "2024-01-25T11:31:43.152Z", "toTime": "2024-01-25T11:37:13.238Z" } } }, "schema": { "$ref": "#/components/schemas/View" } } }, "description": "" } }, "summary": "Replace a view service", "tags": [ "Views service" ] }, "delete": { "description": "Deletes a view by ID", "operationId": "ViewsService_DeleteView", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteViewResponse" } } }, "description": "" } }, "summary": "Delete view service", "tags": [ "Views service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "description": "id", "examples": [ 52 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true } } ] }, "/dataengine/retention-tags/v1": { "get": { "description": "Returns all retention tags of the team, ordered by `order`.", "operationId": "RetentionsService_GetRetentions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRetentionsResponse" } } }, "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 Retentions", "tags": [ "Retentions Service" ] }, "post": { "description": "Renames retention tags by id and returns the retentions of the request, in request order. A retention that the request leaves out keeps its name. An update cannot add or remove retentions or change their order.", "operationId": "RetentionsService_UpdateRetentions", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retentionUpdateElements": { "description": "List of retention tag updates to apply. A retention that the list leaves out keeps its name, and an empty list changes nothing. The list holds at most the number of retention tags of the team.", "items": { "$ref": "#/components/schemas/RetentionUpdateElement" }, "minItems": 0, "type": "array" } }, "required": [ "retentionUpdateElements" ], "title": "Update Retentions Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRetentionsResponse" } } }, "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" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request changes the name of the first retention" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "An id does not exist" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update Retentions", "tags": [ "Retentions Service" ] } }, "/dataengine/retention-tags/v1/activate": { "post": { "description": "Activates the specified retention tags.", "operationId": "RetentionsService_ActivateRetentions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateRetentionsResponse" } } }, "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": "Activate Retentions", "tags": [ "Retentions Service" ] } }, "/dataengine/retention-tags/v1/enabled": { "get": { "description": "Returns the enabled retention tags for the team.", "operationId": "RetentionsService_GetRetentionsEnabled", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRetentionsEnabledResponse" } } }, "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 Retentions Enabled", "tags": [ "Retentions Service" ] } }, "/dataplan/data-usage/v1/capabilities": { "get": { "description": "Returns the labels, measurement kinds, units, and per-request limits supported by the public data-usage API in v1, so clients can validate queries before submitting them.\n\nRequires the following permissions:\n- `data-usage:Read`", "operationId": "DataUsageQueryService_GetDataUsageCapabilities", "responses": { "200": { "content": { "application/json": { "example": { "maxFilterValues": 256, "maxFilters": 8, "maxGroupByLabels": 6, "maxUsageEntriesPerMessage": 1000, "supportedLabels": [ { "highCardinality": false, "key": "feature_id", "keyDescription": "Coralogix feature identifier such as logs_ingestion.", "knownValues": [ { "description": "Log volume ingested.", "value": "logs_ingestion" } ] } ], "supportedMeasurements": [ { "description": "Bytes processed.", "kind": "MEASUREMENT_KIND_PROCESSED_DATA_SIZE", "unit": "MEASUREMENT_UNIT_BYTES" } ] }, "schema": { "$ref": "#/components/schemas/GetDataUsageCapabilitiesResponse" } } }, "description": "" } }, "summary": "Get data usage capabilities", "tags": [ "Data Usage Query Service" ], "x-coralogixPermissions": [ "data-usage:Read" ] } }, "/dataplan/data-usage/v1/query": { "post": { "description": "Returns billable data usage aggregated into daily or hourly buckets. Supports filtering and grouping by labels listed by the capabilities endpoint.\n\nRequires the following permissions:\n- `data-usage:Read`", "operationId": "DataUsageQueryService_DataUsage", "requestBody": { "content": { "application/json": { "schema": { "description": "Shared query payload used by both unary and streamed data-usage methods.", "oneOf": [ { "required": [ "daily" ], "type": "object" }, { "required": [ "hourly" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "daily" ], "type": "object" }, { "required": [ "hourly" ], "type": "object" } ] }, "type": "object" } ], "properties": { "daily": { "$ref": "#/components/schemas/UsageDailyQuery" }, "filters": { "description": "Label predicates applied before aggregation.", "items": { "$ref": "#/components/schemas/UsageLabelFilter" }, "maxItems": 16, "minItems": 0, "type": "array" }, "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": { "description": "Measurement kind filter applied before aggregation. Omit (or pass an empty list) to include all supported measurement kinds.", "items": { "$ref": "#/components/schemas/UsageMeasurementKind" }, "maxItems": 8, "minItems": 0, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "buckets": [ { "entries": [ { "labels": [ { "key": "feature_id", "value": "logs_ingestion" } ], "measurements": [ { "cxQuotaUnits": { "value": "1.5" }, "kind": "MEASUREMENT_KIND_PROCESSED_DATA_SIZE", "measuredUnit": "MEASUREMENT_UNIT_BYTES", "measuredValue": "1073741824" } ] } ], "range": { "end": "2026-06-02T00:00:00.000Z", "start": "2026-06-01T00:00:00.000Z" } } ], "queryRange": { "end": "2026-06-08T00:00:00.000Z", "start": "2026-06-01T00:00:00.000Z" } }, "schema": { "$ref": "#/components/schemas/DataUsageResponse" } } }, "description": "" } }, "summary": "Query data usage", "tags": [ "Data Usage Query Service" ], "x-coralogixPermissions": [ "data-usage:Read" ] } }, "/dataplan/quota-rules/v1": { "get": { "description": "Returns the current quota allocation rules.\n\nRequires the following permissions:\n- `team-quota-rules:Read`", "operationId": "QuotaAllocationRuleSetService_GetQuotaAllocationRuleSet", "parameters": [ { "description": "Unique identifier.", "in": "query", "name": "id", "required": false, "schema": { "description": "Unique identifier.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuotaAllocationRuleSetResponse" } } }, "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": "Rule set not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get quota allocation rule set", "tags": [ "Quota Allocation Rule Set service" ], "x-coralogixPermissions": [ "team-quota-rules:Read" ] }, "put": { "description": "Updates the quota allocation rules.\n\nRequires the following permissions:\n- `team-quota-rules:Manage`", "operationId": "QuotaAllocationRuleSetService_ReplaceQuotaAllocationRuleSet", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to replace quota allocation rule set", "properties": { "ruleSet": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRuleSet" } }, "required": [ "ruleSet" ], "title": "Replace quota allocation rule set request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceQuotaAllocationRuleSetResponse" } } }, "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": "Rule set not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Replace quota allocation rule set", "tags": [ "Quota Allocation Rule Set service" ], "x-coralogixPermissions": [ "team-quota-rules:Manage" ] }, "post": { "description": "Creates new quota allocation rules.\n\nRequires the following permissions:\n- `team-quota-rules:Manage`", "operationId": "QuotaAllocationRuleSetService_CreateQuotaAllocationRuleSet", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new quota allocation rule set", "properties": { "ruleSet": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRuleSet" } }, "required": [ "ruleSet" ], "title": "Create quota allocation rule set request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQuotaAllocationRuleSetResponse" } } }, "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": "Rule set already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create quota allocation rule set", "tags": [ "Quota Allocation Rule Set service" ], "x-coralogixPermissions": [ "team-quota-rules:Manage" ] }, "delete": { "description": "Deletes the quota allocation rules.\n\nRequires the following permissions:\n- `team-quota-rules:Manage`", "operationId": "QuotaAllocationRuleSetService_DeleteQuotaAllocationRuleSet", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteQuotaAllocationRuleSetResponse" } } }, "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": "Rule set not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete quota allocation rule set", "tags": [ "Quota Allocation Rule Set service" ], "x-coralogixPermissions": [ "team-quota-rules:Manage" ] } }, "/dataplans/log-policies/v1": { "put": { "description": "Updates the log data retention policies.", "operationId": "PoliciesService_AtomicOverwriteLogPolicies", "requestBody": { "content": { "application/json": { "schema": { "description": "In an atomic operation delete all existing log policies and create the provided list by order.", "properties": { "policies": { "description": "Replaces every log policy of the team with this list, in this order: the first policy gets order 1. An overwrite that changes the policies gives each a new id; one that sends the stored policies again keeps their ids. An empty list deletes every log policy.", "items": { "$ref": "#/components/schemas/CreateLogPolicyRequest" }, "maxItems": 200, "minItems": 0, "type": "array" } }, "required": [ "policies" ], "title": "Atomic Overwrite Log Policies Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicOverwriteLogPoliciesResponse" } } }, "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": "Two policies of the request have the same name" }, "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": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Atomic Overwrite Log Policies", "tags": [ "Policies Service" ] } }, "/dataplans/policies/v1": { "get": { "description": "Returns all data policies for the team.", "operationId": "PoliciesService_GetCompanyPolicies", "parameters": [ { "description": "When true, return only policies that are currently enabled.", "in": "query", "name": "enabled_only", "required": false, "schema": { "description": "When true, return only policies that are currently enabled.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, { "description": "Filter policies by data source type (for example logs or spans).", "in": "query", "name": "source_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/v1.SourceType" } ], "description": "Filter policies by data source type (for example logs or spans).", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanyPoliciesResponse" } } }, "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 Company Policies", "tags": [ "Policies Service" ] }, "put": { "description": "Updates an existing data policy.", "operationId": "PoliciesService_UpdatePolicy", "requestBody": { "content": { "application/json": { "schema": { "description": "This data structue is used to update an existing policy.", "oneOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" } ] }, "type": "object" } ], "properties": { "applicationRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "archiveRetention": { "$ref": "#/components/schemas/ArchiveRetention" }, "description": { "description": "Optional free-text description of the policy's purpose. Only Latin-1 characters are accepted.", "examples": [ "My Policy Description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Indicates whether the policy should be actively evaluated and applied.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier of the policy to update.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "logRules": { "$ref": "#/components/schemas/LogRules" }, "name": { "description": "Human-readable name for the policy. Only Latin-1 characters are accepted.", "examples": [ "My Policy" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "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": { "description": "List of data targets/destinations to which this policy routes data.", "items": { "$ref": "#/components/schemas/v1.Target" }, "maxItems": 5, "minItems": 0, "type": "array" } }, "required": [ "id" ], "title": "Update Policy Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicyResponse" } } }, "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 Policy", "tags": [ "Policies Service" ] }, "post": { "description": "Creates a new data policy.", "operationId": "PoliciesService_CreatePolicy", "requestBody": { "content": { "application/json": { "schema": { "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).", "oneOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" } ] }, "type": "object" } ], "properties": { "applicationRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "archiveRetention": { "$ref": "#/components/schemas/ArchiveRetention" }, "description": { "description": "Optional free-text description of the policy's purpose. Only Latin-1 characters are accepted. An omitted description is stored as an empty string.", "examples": [ "My Policy Description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "disabled": { "description": "Whether the policy is created disabled. Defaults to `false`. A policy returns the opposite value as `enabled`.", "type": "boolean" }, "logRules": { "$ref": "#/components/schemas/LogRules" }, "name": { "description": "Human-readable name for the policy. Only Latin-1 characters are accepted.", "examples": [ "My Policy" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "placement": { "$ref": "#/components/schemas/Placement" }, "priority": { "allOf": [ { "$ref": "#/components/schemas/quota.v1.Priority" } ], "description": "The priority of the policy. Set it here, or on every target, not both. With `priorityOverride` and no priority, the policy gets `PRIORITY_TYPE_BLOCK`. The service rejects a policy without a priority, an override, or targets that each have a priority." }, "priorityOverride": { "$ref": "#/components/schemas/PriorityOverride" }, "rumRules": { "$ref": "#/components/schemas/LogRules" }, "spanRules": { "$ref": "#/components/schemas/SpanRules" }, "subsystemRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "targets": { "description": "List of data targets/destinations to which this policy routes data.", "examples": [ [ { "archive_retention": { "id": "archive_retention_id" }, "dataset": "dataset1", "name": "My Target", "priority": "PRIORITY_TYPE_HIGH" } ] ], "items": { "$ref": "#/components/schemas/v1.Target" }, "maxItems": 5, "minItems": 0, "type": "array" } }, "required": [ "name" ], "title": "Create Policy Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePolicyResponse" } } }, "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" }, "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": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create Policy", "tags": [ "Policies Service" ] } }, "/dataplans/policies/v1/all/forecast-usage": { "post": { "description": "Forecasts the usage in bytes that a draft TCO policy would match over the requested time window, given its application/subsystem rules and log or span filters. Use this before saving a new or modified policy to see the impact on your quota.", "operationId": "PoliciesService_ForecastPolicyUsage", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "oneOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "logRules" ], "type": "object" }, { "required": [ "spanRules" ], "type": "object" }, { "required": [ "rumRules" ], "type": "object" } ] }, "type": "object" } ] }, { "oneOf": [ { "required": [ "day" ], "type": "object" }, { "required": [ "week" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "day" ], "type": "object" }, { "required": [ "week" ], "type": "object" } ] }, "type": "object" } ] } ], "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.", "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": { "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.", "examples": [ "3600000" ], "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "week": { "$ref": "#/components/schemas/Week" } }, "title": "Forecast Policy Usage Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "estimatedBytes": "13251739648" }, "schema": { "$ref": "#/components/schemas/ForecastPolicyUsageResponse" } } }, "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": "Forecast Policy Usage", "tags": [ "Policies Service" ] } }, "/dataplans/policies/v1/all/reorder": { "post": { "description": "Reorders all data policies.", "operationId": "PoliciesService_ReorderPolicies", "requestBody": { "content": { "application/json": { "schema": { "description": "This data structue is used to reorder policies.", "properties": { "orders": { "description": "The orders.", "items": { "$ref": "#/components/schemas/PolicyOrder" }, "maxItems": 200, "minItems": 0, "type": "array" }, "sourceType": { "$ref": "#/components/schemas/v1.SourceType" } }, "required": [ "orders", "sourceType" ], "title": "Reorder Policies Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderPoliciesResponse" } } }, "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": "Reorder Policies", "tags": [ "Policies Service" ] } }, "/dataplans/policies/v1/all/test-policies": { "post": { "description": "Tests the data policies against sample data.", "operationId": "PoliciesService_BulkTestLogPolicies", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to test multiple log policies.", "properties": { "metaFieldsValuesList": { "description": "The meta fields values list.", "items": { "$ref": "#/components/schemas/LogMetaFieldsValues" }, "maxItems": 50, "minItems": 0, "type": "array" } }, "required": [ "metaFieldsValuesList" ], "title": "Bulk Test Log Policies Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkTestLogPoliciesResponse" } } }, "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": "Bulk Test Log Policies", "tags": [ "Policies Service" ] } }, "/dataplans/policies/v1/{id}": { "get": { "description": "Returns the details of the specified data policy.", "operationId": "PoliciesService_GetPolicy", "parameters": [ { "description": "The unique identifier of the data policy to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the data policy to retrieve.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPolicyResponse" } } }, "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 Policy by ID", "tags": [ "Policies Service" ] }, "delete": { "description": "Deletes the data policy with the specified ID.", "operationId": "PoliciesService_DeletePolicy", "parameters": [ { "description": "The unique identifier of the data policy to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the data policy to delete.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePolicyResponse" } } }, "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": "Delete Policy", "tags": [ "Policies Service" ] } }, "/dataplans/policiy-settings/v1": { "post": { "description": "Updates data policy settings.", "operationId": "PoliciesService_ReplacePolicySettings", "requestBody": { "content": { "application/json": { "schema": { "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.", "properties": { "logsPolicySettings": { "$ref": "#/components/schemas/LogsPolicySettings" }, "spansPolicySettings": { "$ref": "#/components/schemas/SpansPolicySettings" } }, "title": "Replace Policy Settings Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplacePolicySettingsResponse" } } }, "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": "Replace Policy Settings", "tags": [ "Policies Service" ] } }, "/dataplans/policy-settings/v1": { "get": { "description": "Returns the current data policy settings.", "operationId": "PoliciesService_GetPolicySettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPolicySettingsResponse" } } }, "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 Policy Priority Settings", "tags": [ "Policies Service" ] } }, "/dataplans/rum-policies/v1": { "put": { "description": "Updates RUM data retention policies.", "operationId": "PoliciesService_AtomicOverwriteRumPolicies", "requestBody": { "content": { "application/json": { "schema": { "description": "In an atomic operation delete all existing RUM policies and create the provided list by order.", "properties": { "policies": { "description": "Replaces every RUM policy of the team with this list, in this order: the first policy gets order 1. An overwrite that changes the policies gives each a new id; one that sends the stored policies again keeps their ids. An empty list deletes every RUM policy. RUM policies do not accept the `PRIORITY_TYPE_HIGH` priority and have no targets.", "items": { "$ref": "#/components/schemas/CreateRumPolicyRequest" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, "required": [ "policies" ], "title": "Atomic Overwrite Rum Policies Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "createResponses": [ { "policy": { "companyId": 1234, "deleted": false, "description": "My RUM Policy Description", "enabled": true, "id": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "name": "My RUM Policy", "order": 1, "priority": "PRIORITY_TYPE_MEDIUM", "rumRules": { "severities": [ "SEVERITY_ERROR", "SEVERITY_CRITICAL" ] } } } ] }, "schema": { "$ref": "#/components/schemas/AtomicOverwriteRumPoliciesResponse" } } }, "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": "Two policies of the request have the same name" }, "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": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Atomic Overwrite Rum Policies", "tags": [ "Policies Service" ] } }, "/dataplans/span-policies/v1": { "put": { "description": "Updates span data retention policies.", "operationId": "PoliciesService_AtomicOverwriteSpanPolicies", "requestBody": { "content": { "application/json": { "schema": { "description": "In an atomic operation delete all existing span policies and create the provided list by order.", "properties": { "policies": { "description": "Replaces every span policy of the team with this list, in this order: the first policy gets order 1. An overwrite that changes the policies gives each a new id; one that sends the stored policies again keeps their ids. An empty list deletes every span policy.", "items": { "$ref": "#/components/schemas/CreateSpanPolicyRequest" }, "maxItems": 200, "minItems": 0, "type": "array" } }, "required": [ "policies" ], "title": "Atomic Overwrite Span Policies Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicOverwriteSpanPoliciesResponse" } } }, "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": "Two policies of the request have the same name" }, "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": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Atomic Overwrite Span Policies", "tags": [ "Policies Service" ] } }, "/enrichment-rules/custom-enrichment-rules/v1": { "get": { "description": "Returns all custom enrichment rules.", "operationId": "CustomEnrichmentService_GetCustomEnrichments", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomEnrichmentsResponse" } } }, "description": "" } }, "summary": "Get Custom Enrichments", "tags": [ "Custom Enrichments Service" ] }, "put": { "description": "Updates a custom enrichment rule.", "operationId": "CustomEnrichmentService_UpdateCustomEnrichment", "requestBody": { "content": { "application/json": { "schema": { "description": "This request data structure is used to update a custom enrichment", "properties": { "customEnrichmentId": { "description": "The custom enrichment id.", "examples": [ 1 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "description": { "description": "New human-readable description of the custom enrichment.", "examples": [ "custom_enrichment_description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "file": { "$ref": "#/components/schemas/File" }, "name": { "description": "New human-readable name for the custom enrichment. May contain only letters, digits, and underscores.", "examples": [ "custom_enrichment_name" ], "maxLength": 255, "minLength": 1, "pattern": "^\\w+$", "type": "string", "x-coralogix-presence": true } }, "required": [ "customEnrichmentId", "name", "description", "file" ], "title": "Update Custom Enrichment Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomEnrichmentResponse" } } }, "description": "" } }, "summary": "Update Custom Enrichment", "tags": [ "Custom Enrichments Service" ] }, "post": { "description": "Creates a new custom enrichment rule.", "operationId": "CustomEnrichmentService_CreateCustomEnrichment", "requestBody": { "content": { "application/json": { "schema": { "description": "This request data structure is used to create a custom enrichment", "properties": { "description": { "description": "Human-readable description of the custom enrichment.", "examples": [ "custom_enrichment_description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "file": { "$ref": "#/components/schemas/File" }, "name": { "description": "Human-readable name for the custom enrichment. May contain only letters, digits, and underscores.", "examples": [ "custom_enrichment_name" ], "maxLength": 255, "minLength": 1, "pattern": "^\\w+$", "type": "string", "x-coralogix-presence": true } }, "required": [ "name", "description", "file" ], "title": "Create Custom Enrichment Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomEnrichmentResponse" } } }, "description": "" } }, "summary": "Create Custom Enrichments", "tags": [ "Custom Enrichments Service" ] } }, "/enrichment-rules/custom-enrichment-rules/v1/all/contents": { "post": { "description": "Returns the contents of all custom enrichment data.", "operationId": "CustomEnrichmentService_SearchCustomEnrichmentData", "parameters": [ { "description": "Search clauses used to filter custom enrichment data.", "in": "query", "name": "search_clauses", "required": false, "schema": { "description": "Search clauses used to filter custom enrichment data.", "items": { "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" }, "oneOf": [ { "required": [ "id" ], "type": "object" }, { "required": [ "name" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "id" ], "type": "object" }, { "required": [ "name" ], "type": "object" } ] }, "type": "object" } ], "properties": { "id": { "description": "Search by the numeric ID of the custom enrichment.", "examples": [ 1 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "name": { "description": "Search by the name of the custom enrichment.", "examples": [ "custom_enrichment_name" ], "maxLength": 255, "minLength": 1, "pattern": "^\\w+$", "type": "string", "x-coralogix-presence": true } }, "title": "Search Clause", "type": "object" }, "maxItems": 1000, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCustomEnrichmentDataResponse" } } }, "description": "" } }, "summary": "Search Custom Enrichment Data", "tags": [ "Custom Enrichments Service" ] } }, "/enrichment-rules/custom-enrichment-rules/v1/{id}": { "get": { "description": "Returns the details of the specified custom enrichment rule.", "operationId": "CustomEnrichmentService_GetCustomEnrichment", "parameters": [ { "description": "The unique identifier of the custom enrichment rule.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the custom enrichment rule.", "examples": [ 1 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomEnrichmentResponse" } } }, "description": "" } }, "summary": "Get Custom Enrichment", "tags": [ "Custom Enrichments Service" ] }, "delete": { "description": "Deletes the custom enrichment rule with the specified ID.", "operationId": "CustomEnrichmentService_DeleteCustomEnrichment", "parameters": [ { "description": "The unique identifier of the custom enrichment rule to delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the custom enrichment rule to delete.", "examples": [ 1 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCustomEnrichmentResponse" } } }, "description": "" } }, "summary": "Delete Custom Enrichments", "tags": [ "Custom Enrichments Service" ] } }, "/enrichment-rules/enrichment-rules/v1": { "get": { "description": "Returns all enrichment rules for the team.", "operationId": "EnrichmentService_GetEnrichments", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEnrichmentsResponse" } } }, "description": "" } }, "summary": "Get Enrichments", "tags": [ "Enrichments Service" ] }, "put": { "description": "Updates enrichment rules.", "operationId": "EnrichmentService_AtomicOverwriteEnrichments", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to atomically update enrichment rules.", "properties": { "enrichmentFields": { "deprecated": true, "description": "Deprecated: enrichment field definitions.", "items": { "$ref": "#/components/schemas/EnrichmentFieldDefinition" }, "maxItems": 100, "minItems": 0, "type": "array" }, "enrichmentType": { "allOf": [ { "$ref": "#/components/schemas/EnrichmentType" } ], "deprecated": true }, "requestEnrichments": { "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).", "items": { "$ref": "#/components/schemas/EnrichmentRequestModel" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicOverwriteEnrichmentsResponse" } } }, "description": "" } }, "summary": "Atomic Overwrite for CustomEnrichments only", "tags": [ "Enrichments Service" ] }, "post": { "description": "Creates new enrichment rules.", "operationId": "EnrichmentService_AddEnrichments", "requestBody": { "content": { "application/json": { "schema": { "description": "This response data structure represents a collection of enrichments", "properties": { "requestEnrichments": { "description": "The request enrichments. The total number of enrichment rules is limited by the account's enrichment limit (5 by default).", "items": { "$ref": "#/components/schemas/EnrichmentRequestModel" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "required": [ "requestEnrichments" ], "title": "Enrichments Creation Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEnrichmentsResponse" } } }, "description": "" } }, "summary": "Add Enrichments", "tags": [ "Enrichments Service" ] }, "delete": { "description": "Deletes all enrichment rules for the team.", "operationId": "EnrichmentService_RemoveEnrichments", "parameters": [ { "description": "The unique identifiers of the enrichment rules to delete.", "in": "query", "name": "enrichment_ids", "required": true, "schema": { "description": "The unique identifiers of the enrichment rules to delete.", "examples": [ [ 1, 2, 3 ] ], "items": { "description": "The unique identifiers of the enrichment rules to delete.", "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "maxItems": 1000, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveEnrichmentsResponse" } } }, "description": "" } }, "summary": "Delete Enrichments", "tags": [ "Enrichments Service" ] } }, "/enrichment-rules/enrichment-rules/v1/all": { "put": { "description": "Atomic Overwrite for ALL types of enrichments. The request is the desired state which will override ALL enrichments. WARNING: This operation will delete all existing enrichments and replace them with the provided ones.", "operationId": "EnrichmentService_AtomicOverwriteAllEnrichments", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to atomically replace all enrichment rules.", "properties": { "requestEnrichments": { "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).", "items": { "$ref": "#/components/schemas/EnrichmentRequestModel" }, "maxItems": 100, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicOverwriteAllEnrichmentsResponse" } } }, "description": "" } }, "summary": "Atomic Overwrite for ALL types of enrichments", "tags": [ "Enrichments Service" ] } }, "/enrichment-rules/enrichment-rules/v1/limit": { "get": { "description": "Returns the maximum number of enrichment rules allowed.", "operationId": "EnrichmentService_GetEnrichmentLimit", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEnrichmentLimitResponse" } } }, "description": "" } }, "summary": "Get Enrichment Limit", "tags": [ "Enrichments Service" ] } }, "/enrichment-rules/enrichment-rules/v1/settings": { "get": { "description": "Returns the current enrichment settings for the team.", "operationId": "EnrichmentService_GetCompanyEnrichmentSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanyEnrichmentSettingsResponse" } } }, "description": "" } }, "summary": "Get Company Enrichment Settings", "tags": [ "Enrichments Service" ] } }, "/events2metrics/events2metrics/v2": { "get": { "description": "Returns all events-to-metrics rules for the team.", "operationId": "Events2MetricService_ListE2M", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListE2MResponse" } } }, "description": "" } }, "summary": "List E2Ms", "tags": [ "Events2Metrics Service" ] }, "put": { "description": "Updates an existing events-to-metrics rule.", "operationId": "Events2MetricService_ReplaceE2M", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" } ] }, "type": "object" } ], "properties": { "createTime": { "description": "RFC3339 timestamp of when this E2M was created.", "examples": [ "2022-06-30T12:30:00.000Z" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "dataSource": { "description": "Optional data source in namespace/dataset_name format. If not set, defaults to the standard logs/spans stream.", "examples": [ "my_namespace/my_dataset" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of this E2M.", "examples": [ "avg and max the latency of catalog service" ], "maxLength": 2000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier for this E2M. Required on update requests.", "examples": [ "d6a3658e-78d2-47d0-9b81-b2c551f01b09" ], "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", "x-coralogix-presence": true }, "isInternal": { "description": "Indicates whether this E2M is for internal use only.", "type": "boolean", "x-coralogix-presence": true }, "logsQuery": { "$ref": "#/components/schemas/v2.LogsQuery" }, "metricFields": { "description": "Metric fields to extract and aggregate from the events.", "items": { "$ref": "#/components/schemas/v2.MetricField" }, "maxItems": 10, "minItems": 0, "type": "array" }, "metricLabels": { "description": "Metric labels to attach to the generated metrics.", "items": { "$ref": "#/components/schemas/MetricLabel" }, "maxItems": 10, "minItems": 0, "type": "array" }, "name": { "description": "Human-readable name for this E2M.", "examples": [ "Service_catalog_latency" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutations": { "$ref": "#/components/schemas/E2MPermutations" }, "spansQuery": { "$ref": "#/components/schemas/v2.SpansQuery" }, "type": { "$ref": "#/components/schemas/E2MType" }, "updateTime": { "description": "RFC3339 timestamp of when this E2M was last updated.", "examples": [ "2022-06-30T12:30:00.000Z" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "required": [ "id", "name", "type" ], "title": "E2M", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceE2MResponse" } } }, "description": "" } }, "summary": "Replace an E2M", "tags": [ "Events2Metrics Service" ] }, "post": { "description": "Creates a new events-to-metrics rule.", "operationId": "Events2MetricService_CreateE2M", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" } ] }, "type": "object" } ], "properties": { "dataSource": { "description": "Optional data source in namespace/dataset_name format. If not set, defaults to the standard logs/spans stream.", "examples": [ "my_namespace/my_dataset" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description for the new E2M.", "examples": [ "avg and max the latency of catalog service" ], "maxLength": 2000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "logsQuery": { "$ref": "#/components/schemas/v2.LogsQuery" }, "metricFields": { "description": "Metric fields to create and aggregate from the events.", "items": { "$ref": "#/components/schemas/v2.MetricField" }, "maxItems": 10, "minItems": 0, "type": "array" }, "metricLabels": { "description": "Metric labels to attach to the generated metrics.", "items": { "$ref": "#/components/schemas/MetricLabel" }, "maxItems": 10, "minItems": 0, "type": "array" }, "name": { "description": "Human-readable name for the new E2M.", "examples": [ "Service catalog latency" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutationsLimit": { "description": "Maximum number of unique metric permutations allowed for this E2M.", "examples": [ 30000 ], "format": "int32", "maximum": 10000000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "spansQuery": { "$ref": "#/components/schemas/v2.SpansQuery" }, "type": { "$ref": "#/components/schemas/E2MType" } }, "required": [ "name", "type" ], "title": "E2M Create Params", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateE2MResponse" } } }, "description": "" } }, "summary": "Create a new E2M", "tags": [ "Events2Metrics Service" ] } }, "/events2metrics/events2metrics/v2/all/execute": { "post": { "description": "Atomically executes a batch of events-to-metrics rules.", "operationId": "Events2MetricService_AtomicBatchExecuteE2M", "requestBody": { "content": { "application/json": { "schema": { "description": "Request containing an atomic list of events-to-metrics actions to execute.", "properties": { "requests": { "description": "The requests.", "items": { "$ref": "#/components/schemas/E2MExecutionRequest" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtomicBatchExecuteE2MResponse" } } }, "description": "" } }, "summary": "Atomic Batch Execute E2M", "tags": [ "Events2Metrics Service" ] } }, "/events2metrics/events2metrics/v2/{id}": { "get": { "description": "Returns the details of the specified events-to-metrics rule.", "operationId": "Events2MetricService_GetE2M", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetE2MResponse" } } }, "description": "" } }, "summary": "Get an E2M", "tags": [ "Events2Metrics Service" ] }, "delete": { "description": "Deletes the events-to-metrics rule with the specified ID.", "operationId": "Events2MetricService_DeleteE2M", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteE2MResponse" } } }, "description": "" } }, "summary": "Delete an E2M", "tags": [ "Events2Metrics Service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "description": "Unique identifier.", "examples": [ "d6a3658e-78d2-47d0-9b81-b2c551f01b09" ], "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", "x-coralogix-presence": true } } ] }, "/events2metrics/labels/v2/cardinalities": { "get": { "description": "Returns cardinality information for events-to-metrics labels.", "operationId": "Events2MetricService_ListLabelsCardinality", "parameters": [ { "description": "Spans-based query used to evaluate label cardinality.", "in": "query", "name": "spans_query", "required": false, "schema": { "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" }, "properties": { "actionFilters": { "description": "The action filters.", "items": { "description": "The action filters.", "examples": [ "myAction" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "applicationnameFilters": { "description": "The applicationname filters.", "items": { "description": "The applicationname filters.", "examples": [ "myApp" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "lucene": { "description": "The lucene.", "examples": [ "applicationName:myApp" ], "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "serviceFilters": { "description": "The service filters.", "items": { "description": "The service filters.", "examples": [ "myService" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "subsystemnameFilters": { "description": "The subsystemname filters.", "items": { "description": "The subsystemname filters.", "examples": [ "mySubsystem" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "title": "SpansQuery", "type": "object" } }, { "description": "Logs-based query used to evaluate label cardinality.", "in": "query", "name": "logs_query", "required": false, "schema": { "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" }, "properties": { "alias": { "description": "The alias.", "examples": [ "new_query" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "applicationnameFilters": { "description": "The applicationname filters.", "items": { "description": "The applicationname filters.", "examples": [ "app_name" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "lucene": { "description": "The lucene.", "examples": [ "log_obj.numeric_field: [50 TO 100]" ], "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severityFilters": { "description": "The severity filters.", "items": { "$ref": "#/components/schemas/logs2metrics.v2.Severity" }, "maxItems": 7, "minItems": 0, "type": "array" }, "subsystemnameFilters": { "description": "The subsystemname filters.", "items": { "description": "The subsystemname filters.", "examples": [ "sub_name" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "title": "SpansQuery", "type": "object" } }, { "description": "The metric labels to evaluate cardinality for.", "in": "query", "name": "metric_labels", "required": false, "schema": { "description": "The metric labels to evaluate cardinality for.", "items": { "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" }, "properties": { "sourceField": { "description": "The source field.", "examples": [ "log_obj.string_value" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targetLabel": { "description": "The target label.", "examples": [ "alias_label_name" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\w/-]+$", "type": "string", "x-coralogix-presence": true } }, "required": [ "targetLabel", "sourceField" ], "title": "Metric Label", "type": "object" }, "maxItems": 10, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLabelsCardinalityResponse" } } }, "description": "" } }, "summary": "List E2M Labels Cardinality", "tags": [ "Events2Metrics Service" ] } }, "/events2metrics/limits/v2": { "get": { "description": "Returns the events-to-metrics quota limits for the team.", "operationId": "Events2MetricService_GetLimits", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLimitsResponse" } } }, "description": "" } }, "summary": "Get E2M Limits", "tags": [ "Events2Metrics Service" ] } }, "/fleet-management/configuration-groups/v1": { "get": { "description": "Lists fleet-manager configuration groups, newest first. Archived groups are excluded unless include_archived is true.", "operationId": "ConfigurationGroupService_ListConfigurationGroups", "parameters": [ { "description": "When true, include archived groups, each with its latest configuration family, including an archived family.", "in": "query", "name": "include_archived", "required": false, "schema": { "description": "When true, include archived groups, each with its latest configuration family, including an archived family.", "type": "boolean", "x-coralogix-presence": true } }, { "description": "Maximum number of groups to return. Defaults to 100 and cannot exceed 256.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Maximum number of groups to return. Defaults to 100 and cannot exceed 256.", "examples": [ 100 ], "format": "int32", "maximum": 256, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, { "description": "Opaque token returned by a previous list response. Send it with the same include_archived value as that request.", "in": "query", "name": "page_token", "required": false, "schema": { "description": "Opaque token returned by a previous list response. Send it with the same include_archived value as that request.", "examples": [ "AZdtCKSZq3sAAAAAAAAAAQ" ], "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string", "x-coralogix-presence": true } }, { "description": "Response view. BASIC returns group metadata without configuration families. FULL returns the complete group. Omitted or unspecified retains the current full response.", "in": "query", "name": "view", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationGroupView" } ], "description": "Response view. BASIC returns group metadata without configuration families. FULL returns the complete group. Omitted or unspecified retains the current full response." } } ], "responses": { "200": { "content": { "application/json": { "example": { "groups": [ { "archived": false, "description": "Collector configuration group for production.", "family": { "active": true, "id": "01975ed4-9c1b-7c2a-9e5f-526614174001", "lastActivatedAt": "2026-10-08T09:41:01.000Z", "raw": { "remoteConfigurations": [ { "agentSelector": { "attributes": { "service.name": "checkout" } }, "createdAt": "2026-10-08T09:41:01.000Z", "hash": "3f2b8c1d9e7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c", "id": "01975ed4-9c1c-7d3b-af60-626614174002", "name": "traces", "rawConfiguration": "exporters:\n debug: {}\nreceivers:\n otlp:\n protocols:\n grpc: {}\nservice:\n pipelines:\n traces:\n exporters:\n - debug\n receivers:\n - otlp", "updatedAt": "2026-10-08T09:41:01.000Z" } ] }, "version": "1" }, "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Production collectors", "priorityOrder": 100, "tags": [ "production" ] } ], "nextPageToken": "AZdtCKSZq3sAAAAAAAAAAQ" }, "schema": { "$ref": "#/components/schemas/ListConfigurationGroupsResponse" } } }, "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 configuration groups", "tags": [ "Fleet Manager Configuration Groups" ], "x-stability": "preview" }, "post": { "description": "Creates a configuration group with its initial family. Send group settings and a single `family` object as the request body; the response returns the created group with its latest `family`. Set `family.active` to `true` to make the initial configuration available to matching agents. When `active` is omitted, the family is inactive. A successful response confirms creation; check Fleet Management for agent application status.", "operationId": "ConfigurationGroupService_CreateConfigurationGroup", "requestBody": { "content": { "application/json": { "schema": { "description": "Group settings and the initial family. The service assigns the group ID.", "properties": { "description": { "description": "Description of the group's purpose.", "examples": [ "Collector configuration for production Linux virtual machines." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "family": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationFamilyCreate" } ], "description": "Initial family containing the Collector configurations and agent selectors." }, "name": { "description": "Display name shown in Fleet Management, unique among the team's configuration groups.", "examples": [ "Production Linux VMs" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "priorityOrder": { "default": 0, "description": "Selection priority when multiple configurations match an agent. Higher values take precedence. Defaults to 0.", "examples": [ 100 ], "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "x-coralogix-presence": true }, "tags": { "description": "Tags for organizing the group. Tags do not select agents.", "examples": [ [ "production" ] ], "items": { "description": "Tags for organizing the group. Tags do not select agents.", "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" } }, "required": [ "name", "family" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "archived": false, "description": "Collector configuration group for production.", "family": { "active": true, "id": "01975ed4-9c1b-7c2a-9e5f-526614174001", "lastActivatedAt": "2026-10-08T09:41:01.000Z", "raw": { "remoteConfigurations": [ { "agentSelector": { "attributes": { "service.name": "checkout" } }, "createdAt": "2026-10-08T09:41:01.000Z", "hash": "3f2b8c1d9e7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c", "id": "01975ed4-9c1c-7d3b-af60-626614174002", "name": "traces", "rawConfiguration": "exporters:\n debug: {}\nreceivers:\n otlp:\n protocols:\n grpc: {}\nservice:\n pipelines:\n traces:\n exporters:\n - debug\n receivers:\n - otlp", "updatedAt": "2026-10-08T09:41:01.000Z" } ] }, "version": "1" }, "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Production collectors", "priorityOrder": 100, "tags": [ "production" ] }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationGroup" } ], "description": "Created configuration group." } } }, "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": "Configuration group already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create configuration group", "tags": [ "Fleet Manager Configuration Groups" ], "x-stability": "preview" } }, "/fleet-management/configuration-groups/v1/{id}": { "get": { "description": "Returns a configuration group with its latest family. Family `active` indicates eligibility for delivery, not whether an agent has successfully applied the configuration. An archived group returns 404 unless `include_archived=true`; when included, an archived group is returned with its latest configuration family, which may itself be archived.", "operationId": "ConfigurationGroupService_GetConfigurationGroup", "parameters": [ { "description": "When true, return an archived group with its latest configuration family, including an archived family. Otherwise an archived group returns 404.", "in": "query", "name": "include_archived", "required": false, "schema": { "description": "When true, return an archived group with its latest configuration family, including an archived family. Otherwise an archived group returns 404.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "example": { "archived": false, "description": "Collector configuration group for production.", "family": { "active": true, "id": "01975ed4-9c1b-7c2a-9e5f-526614174001", "lastActivatedAt": "2026-10-08T09:41:01.000Z", "raw": { "remoteConfigurations": [ { "agentSelector": { "attributes": { "service.name": "checkout" } }, "createdAt": "2026-10-08T09:41:01.000Z", "hash": "3f2b8c1d9e7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c", "id": "01975ed4-9c1c-7d3b-af60-626614174002", "name": "traces", "rawConfiguration": "exporters:\n debug: {}\nreceivers:\n otlp:\n protocols:\n grpc: {}\nservice:\n pipelines:\n traces:\n exporters:\n - debug\n receivers:\n - otlp", "updatedAt": "2026-10-08T09:41:01.000Z" } ] }, "version": "1" }, "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Production collectors", "priorityOrder": 100, "tags": [ "production" ] }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationGroup" } ], "description": "Requested configuration group." } } }, "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": "Configuration group not found or archived" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get configuration group", "tags": [ "Fleet Manager Configuration Groups" ], "x-stability": "preview" }, "patch": { "description": "Updates the fields listed in `update_mask`; other fields are unchanged. Changing `family.raw` or `family.preset` creates a new configuration family version only when the content changes. Send group field values directly in the request body. To activate the latest family, send `{\"family\":{\"active\":true}}` with `update_mask=family.active`. The response contains the latest family. An archived group returns 404.", "operationId": "ConfigurationGroupService_UpdateConfigurationGroup", "parameters": [ { "description": "Comma-separated fields to update: name, description, tags, priorityOrder, family.description, family.active, family.raw, family.preset, or one field inside family.raw or family.preset, such as family.raw.metadata or family.preset.chartVersion. family.raw and family.preset replace the whole family content; a field inside them changes only that field and keeps the others. A listed field that is omitted from the body is cleared (description, tags, family.description, and optional fields inside family.raw or family.preset) or reset to its default (priorityOrder 0, family.active false). name cannot be cleared, and family.raw.remoteConfigurations cannot be empty. Changing family.preset.chartVersion without family.preset.integrationVersion uses the default integration version of the new chart version. The body must include the arm being changed, and only the arm matching the current family's content type is accepted (raw and preset families cannot be switched). A bare family, unknown paths, and * return 400.", "in": "query", "name": "update_mask", "required": true, "schema": { "description": "Comma-separated fields to update: name, description, tags, priorityOrder, family.description, family.active, family.raw, family.preset, or one field inside family.raw or family.preset, such as family.raw.metadata or family.preset.chartVersion. family.raw and family.preset replace the whole family content; a field inside them changes only that field and keeps the others. A listed field that is omitted from the body is cleared (description, tags, family.description, and optional fields inside family.raw or family.preset) or reset to its default (priorityOrder 0, family.active false). name cannot be cleared, and family.raw.remoteConfigurations cannot be empty. Changing family.preset.chartVersion without family.preset.integrationVersion uses the default integration version of the new chart version. The body must include the arm being changed, and only the arm matching the current family's content type is accepted (raw and preset families cannot be switched). A bare family, unknown paths, and * return 400.", "examples": [ "family.active" ], "maxLength": 512, "minLength": 1, "pattern": "^[A-Za-z_][A-Za-z0-9_.]*(,[A-Za-z_][A-Za-z0-9_.]*)*$", "type": "string", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Configuration group field values for an update. Only fields listed in update_mask are applied.", "properties": { "description": { "description": "Description of the group's purpose.", "examples": [ "Collector configuration for production Linux virtual machines." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "family": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationFamilyUpdate" } ], "description": "Latest configuration family field values." }, "name": { "description": "Display name shown in Fleet Management, unique among the team's configuration groups.", "examples": [ "Production Linux VMs" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "priorityOrder": { "default": 0, "description": "Selection priority when multiple configurations match an agent. Higher values take precedence.", "examples": [ 100 ], "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "x-coralogix-presence": true }, "tags": { "description": "Tags for organizing the group. Tags do not select agents.", "examples": [ [ "production" ] ], "items": { "description": "Tags for organizing the group. Tags do not select agents.", "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "archived": false, "description": "Updated collector configuration group.", "family": { "active": true, "id": "01975ed4-9c1b-7c2a-9e5f-526614174001", "lastActivatedAt": "2026-10-08T09:41:01.000Z", "raw": { "remoteConfigurations": [ { "agentSelector": { "attributes": { "service.name": "checkout" } }, "createdAt": "2026-10-08T09:41:01.000Z", "hash": "3f2b8c1d9e7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c", "id": "01975ed4-9c1c-7d3b-af60-626614174002", "name": "traces", "rawConfiguration": "exporters:\n debug: {}\nreceivers:\n otlp:\n protocols:\n grpc: {}\nservice:\n pipelines:\n traces:\n exporters:\n - debug\n receivers:\n - otlp", "updatedAt": "2026-10-08T09:41:01.000Z" } ] }, "version": "1" }, "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Production collectors", "priorityOrder": 100, "tags": [ "production" ] }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationGroup" } ], "description": "Updated configuration group." } } }, "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": "Configuration group not found or archived" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuration group name already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update configuration group", "tags": [ "Fleet Manager Configuration Groups" ], "x-stability": "preview" }, "parameters": [ { "$ref": "#/components/parameters/id" } ] }, "/fleet-management/configuration-groups/v1/{id}/archive": { "post": { "description": "Archives a fleet-manager configuration group. An already archived group returns 404.", "operationId": "ConfigurationGroupService_ArchiveConfigurationGroup", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/ArchiveConfigurationGroupResponse" } } }, "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": "Configuration group not found or archived" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Archive configuration group", "tags": [ "Fleet Manager Configuration Groups" ], "x-stability": "preview" } }, "/fleet-management/configuration-overlays/v1": { "get": { "description": "Lists configuration overlays, newest first. Archived overlays are excluded unless include_archived is true.", "operationId": "ConfigurationOverlayService_ListConfigurationOverlays", "parameters": [ { "description": "When true, include archived overlays.", "in": "query", "name": "include_archived", "required": false, "schema": { "description": "When true, include archived overlays.", "type": "boolean", "x-coralogix-presence": true } }, { "description": "Maximum number of overlays to return. Defaults to 100 and cannot exceed 256.", "in": "query", "name": "page_size", "required": false, "schema": { "description": "Maximum number of overlays to return. Defaults to 100 and cannot exceed 256.", "format": "int32", "maximum": 256, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, { "description": "Opaque token returned by a previous list response.", "in": "query", "name": "page_token", "required": false, "schema": { "description": "Opaque token returned by a previous list response.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "example": { "overlays": [ { "active": true, "archived": false, "custom": { "configuration": "service:\n telemetry:\n logs:\n level: debug\n", "targets": [ { "createdAt": "2026-09-28T10:05:00.000Z", "id": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3003", "overlayConfigurationFamilyId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1011", "overlayRemoteConfigurationId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1012", "sourceConfigurationFamilyId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e60", "sourceRemoteConfigurationId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e61", "updatedAt": "2026-09-28T10:05:00.000Z" } ] }, "description": "Raises the Collector log level for selected remote configurations.", "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Debug logging overlay", "overlayHash": "b5f7c570911aabc9ec165e379267fdaedf4426d9ca22d27773ce01b8be91fb4b", "parentVersionId": "01975ed4-9c1a-7b3f-8d4e-426614174001", "priorityOrder": 100, "schedules": [ { "createdAt": "2026-09-28T10:05:00.000Z", "description": "Weekend debug logging", "duration": "7200s", "id": "01975ed5-2a12-7b03-8c04-0d0e0f101213", "nextActivation": "2026-10-31T22:00:00.000Z", "recurrence": { "every": 1, "unit": "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_WEEKS" }, "startAt": "2026-10-31T22:00:00.000Z", "state": "CONFIGURATION_OVERLAY_SCHEDULE_STATE_ENABLED", "timeZone": "Europe/Berlin", "updatedAt": "2026-09-28T10:05:00.000Z" } ], "tags": [ "production" ], "version": "2", "versionId": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3002" } ] }, "schema": { "$ref": "#/components/schemas/ListConfigurationOverlaysResponse" } } }, "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 configuration overlays", "tags": [ "Fleet Manager Configuration Overlays" ], "x-stability": "preview" }, "post": { "description": "Creates a custom configuration overlay (OpenTelemetry Collector YAML). It is inactive unless active is true, which needs at least one target.", "operationId": "ConfigurationOverlayService_CreateConfigurationOverlay", "requestBody": { "content": { "application/json": { "schema": { "description": "Payload used to create a custom configuration overlay.", "properties": { "active": { "default": false, "description": "Set true to activate the overlay when it is created.", "type": "boolean", "x-coralogix-presence": true }, "custom": { "allOf": [ { "$ref": "#/components/schemas/CustomConfigurationOverlayCreate" } ], "description": "Custom overlay: an OpenTelemetry Collector YAML fragment and its targets." }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name, unique among unarchived overlays.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "priorityOrder": { "default": 0, "description": "Merge precedence on a shared remote configuration: higher values win, and the newer overlay wins a tie.", "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "x-coralogix-presence": true }, "schedules": { "description": "Activation schedules. Windows must not overlap; a window may start when another ends.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayScheduleCreate" }, "maxItems": 10, "minItems": 0, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" }, "tags": { "description": "Tags attached to the configuration overlay.", "items": { "description": "Tags attached to the configuration overlay.", "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" } }, "required": [ "name", "custom" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "active": false, "archived": false, "custom": { "configuration": "service:\n telemetry:\n logs:\n level: debug\n", "targets": [] }, "description": "Raises the Collector log level for selected remote configurations.", "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Debug logging overlay", "overlayHash": "b5f7c570911aabc9ec165e379267fdaedf4426d9ca22d27773ce01b8be91fb4b", "priorityOrder": 100, "schedules": [ { "createdAt": "2026-09-28T10:00:00.000Z", "description": "Weekend debug logging", "duration": "7200s", "id": "01975ed6-3b20-7d55-8c2f-6e3d9b8a4004", "recurrence": { "every": 1, "unit": "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_WEEKS" }, "startAt": "2026-10-31T22:00:00.000Z", "state": "CONFIGURATION_OVERLAY_SCHEDULE_STATE_PAUSED", "timeZone": "Europe/Berlin", "updatedAt": "2026-09-28T10:00:00.000Z" } ], "tags": [ "production" ], "version": "1", "versionId": "01975ed4-9c1a-7b3f-8d4e-426614174001" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlay" } ], "description": "Created configuration overlay." } } }, "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": "Configuration overlay name already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Create configuration overlay", "tags": [ "Fleet Manager Configuration Overlays" ], "x-stability": "preview" } }, "/fleet-management/configuration-overlays/v1/{id}": { "get": { "description": "Gets a fleet-manager configuration overlay by ID.", "operationId": "ConfigurationOverlayService_GetConfigurationOverlay", "parameters": [ { "description": "When true, return an archived overlay. Otherwise an archived overlay returns 404.", "in": "query", "name": "include_archived", "required": false, "schema": { "description": "When true, return an archived overlay. Otherwise an archived overlay returns 404.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "example": { "active": true, "archived": false, "custom": { "configuration": "service:\n telemetry:\n logs:\n level: debug\n", "targets": [ { "createdAt": "2026-09-28T10:05:00.000Z", "id": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3003", "overlayConfigurationFamilyId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1011", "overlayRemoteConfigurationId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1012", "sourceConfigurationFamilyId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e60", "sourceRemoteConfigurationId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e61", "updatedAt": "2026-09-28T10:05:00.000Z" } ] }, "description": "Raises the Collector log level for selected remote configurations.", "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Debug logging overlay", "overlayHash": "b5f7c570911aabc9ec165e379267fdaedf4426d9ca22d27773ce01b8be91fb4b", "parentVersionId": "01975ed4-9c1a-7b3f-8d4e-426614174001", "priorityOrder": 100, "schedules": [ { "createdAt": "2026-09-28T10:05:00.000Z", "description": "Weekend debug logging", "duration": "7200s", "id": "01975ed5-2a12-7b03-8c04-0d0e0f101213", "nextActivation": "2026-10-31T22:00:00.000Z", "recurrence": { "every": 1, "unit": "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_WEEKS" }, "startAt": "2026-10-31T22:00:00.000Z", "state": "CONFIGURATION_OVERLAY_SCHEDULE_STATE_ENABLED", "timeZone": "Europe/Berlin", "updatedAt": "2026-09-28T10:05:00.000Z" } ], "tags": [ "production" ], "version": "2", "versionId": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3002" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlay" } ], "description": "Requested configuration overlay." } } }, "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": "Configuration overlay not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get configuration overlay", "tags": [ "Fleet Manager Configuration Overlays" ], "x-stability": "preview" }, "patch": { "description": "Updates the fields listed in update_mask; a listed field that is omitted from the body is cleared or reset to its default. A change to the content of custom.configuration or custom.targets creates a new version that carries over the schedules. An archived overlay can't be updated. Activation needs a target, and every schedule needs a future window. A version-creating change is rejected while a scheduled window is applying.", "operationId": "ConfigurationOverlayService_UpdateConfigurationOverlay", "parameters": [ { "description": "Comma-separated fields to update: name, description, tags, priorityOrder, active, custom, custom.configuration, custom.targets, schedules. A listed field that is omitted from the body is cleared (description, tags, custom.targets, schedules) or reset to its default (priorityOrder 0, active false); name, custom, and custom.configuration cannot be cleared. Unknown fields and * return 400.", "in": "query", "name": "update_mask", "required": true, "schema": { "description": "Comma-separated fields to update: name, description, tags, priorityOrder, active, custom, custom.configuration, custom.targets, schedules. A listed field that is omitted from the body is cleared (description, tags, custom.targets, schedules) or reset to its default (priorityOrder 0, active false); name, custom, and custom.configuration cannot be cleared. Unknown fields and * return 400.", "maxLength": 512, "minLength": 1, "pattern": "^[A-Za-z_][A-Za-z0-9_.]*(,[A-Za-z_][A-Za-z0-9_.]*)*$", "type": "string", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Configuration overlay field values for an update. Only fields listed in update_mask are applied.", "properties": { "active": { "default": false, "description": "Set true to activate or false to deactivate the overlay. With schedules, activation enables them, and deactivation pauses them and ends a running window.", "type": "boolean", "x-coralogix-presence": true }, "custom": { "allOf": [ { "$ref": "#/components/schemas/CustomConfigurationOverlayUpdate" } ], "description": "Custom overlay fields to update. Rejected for preset overlays." }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name, unique among unarchived overlays.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "priorityOrder": { "default": 0, "description": "Merge precedence on a shared remote configuration: higher values win, and the newer overlay wins a tie.", "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "x-coralogix-presence": true }, "schedules": { "description": "Replaces the schedules of the latest version without creating a version. When the same request changes custom content, the list moves to the new version with new ids. Windows must not overlap; a window may start when another ends. Schedules are matched by startAt, duration, recurrence, and timeZone: a match keeps its id, and other schedules are removed. An empty list on an active overlay applies it continuously, right away.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayScheduleReplace" }, "maxItems": 10, "minItems": 0, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" }, "tags": { "description": "Tags attached to the configuration overlay. Replaces all tags.", "items": { "description": "Tags attached to the configuration overlay. Replaces all tags.", "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 64, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "active": true, "archived": false, "custom": { "configuration": "service:\n telemetry:\n logs:\n level: debug\n", "targets": [ { "createdAt": "2026-09-28T10:05:00.000Z", "id": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3003", "overlayConfigurationFamilyId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1011", "overlayRemoteConfigurationId": "01975ed5-2a11-7a01-8b02-0c0d0e0f1012", "sourceConfigurationFamilyId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e60", "sourceRemoteConfigurationId": "01975e90-1b2c-7d3e-8f40-1a2b3c4d5e61", "updatedAt": "2026-09-28T10:05:00.000Z" } ] }, "description": "Updated overlay description.", "id": "01975ed4-9c1a-7b3f-8d4e-426614174000", "name": "Debug logging overlay", "overlayHash": "b5f7c570911aabc9ec165e379267fdaedf4426d9ca22d27773ce01b8be91fb4b", "parentVersionId": "01975ed4-9c1a-7b3f-8d4e-426614174001", "priorityOrder": 100, "schedules": [ { "createdAt": "2026-09-28T10:05:00.000Z", "description": "Weekend debug logging", "duration": "7200s", "id": "01975ed5-2a12-7b03-8c04-0d0e0f101213", "nextActivation": "2026-10-31T22:00:00.000Z", "recurrence": { "every": 1, "unit": "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_WEEKS" }, "startAt": "2026-10-31T22:00:00.000Z", "state": "CONFIGURATION_OVERLAY_SCHEDULE_STATE_ENABLED", "timeZone": "Europe/Berlin", "updatedAt": "2026-09-28T10:05:00.000Z" } ], "tags": [ "production" ], "version": "2", "versionId": "01975ed5-2a10-7c44-9b1e-5d2c8a7f3002" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlay" } ], "description": "Updated configuration overlay." } } }, "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": "Configuration overlay not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuration overlay name already exists" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update configuration overlay", "tags": [ "Fleet Manager Configuration Overlays" ], "x-stability": "preview" }, "parameters": [ { "$ref": "#/components/parameters/id_2" } ] }, "/fleet-management/configuration-overlays/v1/{id}/archive": { "post": { "description": "Archives a configuration overlay and all its versions. An active overlay must be deactivated before it is archived. Archiving an archived overlay succeeds.", "operationId": "ConfigurationOverlayService_ArchiveConfigurationOverlay", "parameters": [ { "$ref": "#/components/parameters/id_2" } ], "responses": { "200": { "content": { "application/json": { "example": { "id": "01975ed4-9c1a-7b3f-8d4e-426614174000" }, "schema": { "$ref": "#/components/schemas/ArchiveConfigurationOverlayResponse" } } }, "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": "Configuration overlay not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Archive configuration overlay", "tags": [ "Fleet Manager Configuration Overlays" ], "x-stability": "preview" } }, "/incidents/aggregations/v1": { "get": { "description": "Retrieve aggregated incident data with support for grouping and filtering.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_ListIncidentAggregations", "parameters": [ { "description": "Filter for incidents", "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter configuration for incidents", "properties": { "applicationName": { "description": "Filter by application names", "items": { "description": "Filter by application names", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "assignee": { "description": "Filter by assignee", "items": { "description": "Filter by assignee", "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "contextualLabels": { "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValues" }, "description": "Filter by contextual labels", "type": "object" }, "createdAtRange": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "Filters all incidents created at the given time range" }, "displayLabels": { "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValues" }, "description": "Filter by display labels", "type": "object" }, "endTime": { "deprecated": true, "description": "Filters all incidents that were open in the given timeframe end time (deprecated, use incident_open_range instead)", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "incidentDurationRange": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "Filters all active) incidents with the given duration range" }, "isMuted": { "description": "Indicates if the incident is muted", "type": "boolean", "x-coralogix-presence": true }, "metaLabels": { "description": "Filters all incidents with the given meta labels", "items": { "description": "Meta label.", "properties": { "key": { "description": "The key.", "examples": [ "key" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "examples": [ "value" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Incident meta label", "type": "object" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "metaLabelsOp": { "allOf": [ { "$ref": "#/components/schemas/v1.FilterOperator" } ], "description": "The operator for the meta labels filter" }, "searchQuery": { "description": "Incident search query.", "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", "x-coralogix-presence": true }, "incidentField": { "allOf": [ { "$ref": "#/components/schemas/IncidentFields" } ], "description": "The field to search in", "examples": [ "INCIDENTS_FIELDS_STATUS" ] }, "query": { "description": "The search query", "examples": [ "error" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "query" ], "title": "Incident search query", "type": "object" }, "severity": { "description": "Filter by incident severity", "items": { "$ref": "#/components/schemas/IncidentSeverity" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "startTime": { "deprecated": true, "description": "Filters all incidents that were open in the given timeframe start time (deprecated, use incident_open_range instead)", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "state": { "description": "Filter by incident state", "items": { "$ref": "#/components/schemas/IncidentState" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "status": { "description": "Filter by incident status", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "subsystemName": { "description": "Filter by subsystem names", "items": { "description": "Filter by subsystem names", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, "title": "Incident query filter", "type": "object" } }, { "description": "Group by fields for aggregation", "in": "query", "name": "group_bys", "required": false, "schema": { "description": "Group by fields for aggregation", "items": { "oneOf": [ { "required": [ "incidentField" ], "type": "object" }, { "required": [ "contextualLabel" ], "type": "object" } ], "properties": { "contextualLabel": { "description": "The contextual label to group by.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "incidentField": { "allOf": [ { "$ref": "#/components/schemas/IncidentFields" } ], "description": "The field to group by", "examples": [ "INCIDENTS_FIELDS_ID" ] }, "orderByDirection": { "allOf": [ { "$ref": "#/components/schemas/v1.OrderByDirection" } ], "description": "The order by direction.", "examples": [ "ORDER_BY_DIRECTION_ASC" ] } }, "title": "Incident group by", "type": "object" }, "maxItems": 100, "minItems": 0, "type": "array" } }, { "description": "Pagination parameters", "in": "query", "name": "pagination", "required": false, "schema": { "description": "Pagination parameters for list requests", "properties": { "pageSize": { "description": "Number of items to return per page.", "examples": [ 10 ], "format": "int64", "maximum": 10000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Token for the next page of results", "examples": [ "next_page_token" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "pageSize" ], "title": "Pagination request", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentAggregationsResponse" } } }, "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 incident aggregations", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/events/v1": { "get": { "description": "List incident events with support for filtering, pagination, and ordering. This operation accepts a page size of at most 1000 (it defaults to 100 when pageSize is omitted) and rejects larger values, even though the shared pagination schema documents a maximum of 10000.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_ListIncidentEvents", "parameters": [ { "description": "Filter for incident events", "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter configuration for incident events", "properties": { "contextualLabels": { "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValues" }, "description": "The contextual labels of the incident", "type": "object" }, "displayLabels": { "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValues" }, "description": "The display labels of the incident", "type": "object" }, "isMuted": { "description": "Indicates if the incident is muted", "type": "boolean", "x-coralogix-presence": true }, "labels": { "allOf": [ { "$ref": "#/components/schemas/LabelsFilter" } ], "description": "The labels of the incident" }, "name": { "description": "The name of the incident", "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "description": "The severity of the incident", "items": { "$ref": "#/components/schemas/IncidentSeverity" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "status": { "description": "The status of the incident", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "The time range of the incident" } }, "title": "Incident event query filter", "type": "object" } }, { "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.", "in": "query", "name": "pagination", "required": false, "schema": { "description": "Pagination parameters for list requests", "properties": { "pageSize": { "description": "Number of items to return per page.", "examples": [ 10 ], "format": "int64", "maximum": 10000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Token for the next page of results", "examples": [ "next_page_token" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "pageSize" ], "title": "Pagination request", "type": "object" } }, { "description": "Order by fields for incident events", "in": "query", "name": "order_by", "required": false, "schema": { "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/v1.OrderByDirection" } ], "description": "Sort direction (ascending or descending)", "examples": [ "ORDER_BY_DIRECTION_ASC" ] }, "field": { "allOf": [ { "$ref": "#/components/schemas/IncidentEventOrderByFieldType" } ], "description": "Field to order by", "examples": [ "INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED" ] } }, "title": "List incident events order by request", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentEventsResponse" } } }, "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 incident events with filters", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/events/v1/all/count": { "get": { "description": "Retrieve the total count of incident events matching a filter.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_ListIncidentEventsTotalCount", "parameters": [ { "description": "Filter for incident events", "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter configuration for incident events", "properties": { "contextualLabels": { "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValues" }, "description": "The contextual labels of the incident", "type": "object" }, "displayLabels": { "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValues" }, "description": "The display labels of the incident", "type": "object" }, "isMuted": { "description": "Indicates if the incident is muted", "type": "boolean", "x-coralogix-presence": true }, "labels": { "allOf": [ { "$ref": "#/components/schemas/LabelsFilter" } ], "description": "The labels of the incident" }, "name": { "description": "The name of the incident", "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "description": "The severity of the incident", "items": { "$ref": "#/components/schemas/IncidentSeverity" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "status": { "description": "The status of the incident", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "The time range of the incident" } }, "title": "Incident event query filter", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentEventsTotalCountResponse" } } }, "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 total count of incident events", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/events/v1/{event_id}": { "get": { "description": "Retrieve detailed information about a single incident by related alert event id.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_GetIncidentByEventId", "parameters": [ { "$ref": "#/components/parameters/event_id" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncidentByEventIdResponse" } } }, "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 incident by event ID", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/events/v1/{event_id}/acknowledge": { "post": { "description": "Mark incident as acknowledged by event id.\n\nRequires the following permissions:\n- `incidents:acknowledge`", "operationId": "IncidentsService_AcknowledgeIncidentByEventId", "parameters": [ { "$ref": "#/components/parameters/event_id" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeIncidentByEventIdResponse" } } }, "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": "Acknowledge incident by event id", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:acknowledge" ] } }, "/incidents/events/v1/{event_id}/resolve": { "post": { "description": "Mark incident as resolved by event id.\n\nRequires the following permissions:\n- `incidents:close`", "operationId": "IncidentsService_ResolveIncidentByEventId", "parameters": [ { "description": "Event ID associated to the Incident to resolve", "in": "path", "name": "event_id", "required": true, "schema": { "description": "Event ID associated to the Incident to resolve", "examples": [ "event_id_1" ], "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveIncidentByEventIdResponse" } } }, "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": "Resolve incident by event id", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:close" ] } }, "/incidents/filter-values/v1": { "post": { "description": "Returns filter values for incidents based on the provided criteria.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_GetFilterValues", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to get available filter values for incidents", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/IncidentQueryFilter" } ], "description": "Filter for incidents" } }, "title": "Get filter values request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidents.v1.GetFilterValuesResponse" } } }, "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 available filter values", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/filter-values/v1/events": { "get": { "description": "Returns available filter values for incident events.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_ListIncidentEventsFilterValues", "parameters": [ { "description": "Filter for incident events", "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter configuration for incident events", "properties": { "contextualLabels": { "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValues" }, "description": "The contextual labels of the incident", "type": "object" }, "displayLabels": { "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValues" }, "description": "The display labels of the incident", "type": "object" }, "isMuted": { "description": "Indicates if the incident is muted", "type": "boolean", "x-coralogix-presence": true }, "labels": { "allOf": [ { "$ref": "#/components/schemas/LabelsFilter" } ], "description": "The labels of the incident" }, "name": { "description": "The name of the incident", "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "description": "The severity of the incident", "items": { "$ref": "#/components/schemas/IncidentSeverity" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "status": { "description": "The status of the incident", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "maxItems": 1000, "minItems": 0, "type": "array" }, "timestamp": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "The time range of the incident" } }, "title": "Incident event query filter", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentEventsFilterValuesResponse" } } }, "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 available incident event filter values", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/incidents/v1": { "get": { "description": "Retrieve multiple incidents by their IDs in a single request.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_BatchGetIncident", "parameters": [ { "description": "The ids.", "in": "query", "name": "ids", "required": false, "schema": { "description": "The ids.", "items": { "description": "The ids.", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetIncidentResponse" } } }, "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 multiple incidents by IDs", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] }, "post": { "description": "Lists all available incidents based on specified filters and order. The list is ordered in an unspecified direction and sorted by creation time.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_ListIncidents", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to list incidents with filtering, pagination and ordering options", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/IncidentQueryFilter" } ], "description": "Filter for incidents" }, "orderBys": { "description": "Order by fields", "items": { "$ref": "#/components/schemas/v1.OrderBy" }, "maxItems": 100, "minItems": 0, "type": "array" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/incidents.v1.PaginationRequest" } ], "description": "Pagination parameters" } }, "title": "List incidents request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentsResponse" } } }, "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 incidents with filters", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/incidents/v1/all/acknowledge": { "post": { "description": "Mark one or more incidents as acknowledged.\n\nRequires the following permissions:\n- `incidents:acknowledge`", "operationId": "IncidentsService_AcknowledgeIncidents", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to acknowledge one or more incidents", "properties": { "incidentIds": { "description": "List of incident IDs to acknowledge", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ], "items": { "description": "List of incident IDs to acknowledge", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } }, "required": [ "incidentIds" ], "title": "Acknowledge incidents request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeIncidentsResponse" } } }, "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": "Acknowledge incidents", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:acknowledge" ] } }, "/incidents/incidents/v1/all/by-user": { "post": { "description": "Assign one or more incidents to a specific user.\n\nRequires the following permissions:\n- `incidents:assign`", "operationId": "IncidentsService_AssignIncidents", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to assign one or more incidents to a user", "properties": { "assignedTo": { "allOf": [ { "$ref": "#/components/schemas/incidents.v1.UserDetails" } ], "description": "User to assign the incidents to" }, "incidentIds": { "description": "List of incident IDs to assign", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ], "items": { "description": "List of incident IDs to assign", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } }, "required": [ "incidentIds", "assignedTo" ], "title": "Assign incidents request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignIncidentsResponse" } } }, "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": "Assign incidents to a user", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:assign" ] }, "delete": { "description": "Remove user assignments from one or more incidents.\n\nRequires the following permissions:\n- `incidents:assign`", "operationId": "IncidentsService_UnassignIncidents", "parameters": [ { "description": "List of incident IDs to unassign", "in": "query", "name": "incident_ids", "required": true, "schema": { "description": "List of incident IDs to unassign", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ], "items": { "description": "List of incident IDs to unassign", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignIncidentsResponse" } } }, "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": "Remove incident user assignments", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:assign" ] } }, "/incidents/incidents/v1/all/closed": { "post": { "description": "Closes all incidents matching the given criteria.\n\nRequires the following permissions:\n- `incidents:close`", "operationId": "IncidentsService_CloseIncidents", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to close one or more incidents", "properties": { "incidentIds": { "description": "List of incident IDs to close", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ], "items": { "description": "List of incident IDs to close", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } }, "required": [ "incidentIds" ], "title": "Close incidents request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseIncidentsResponse" } } }, "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": "Close incidents", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:close" ] } }, "/incidents/incidents/v1/all/resolve": { "post": { "description": "Mark one or more incidents as resolved.\n\nRequires the following permissions:\n- `incidents:close`", "operationId": "IncidentsService_ResolveIncidents", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to resolve one or more incidents", "properties": { "incidentIds": { "description": "List of incident IDs to resolve", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ], "items": { "description": "List of incident IDs to resolve", "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" }, "maxItems": 10000, "minItems": 1, "type": "array" } }, "required": [ "incidentIds" ], "title": "Resolve incidents request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveIncidentsResponse" } } }, "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": "Resolve incidents", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:close" ] } }, "/incidents/incidents/v1/{id}": { "get": { "description": "Retrieve detailed information about a single incident by its unique identifier.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_GetIncident", "parameters": [ { "description": "Unique identifier.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier.", "examples": [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301" ], "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", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncidentResponse" } } }, "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 incident by ID", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/incidents/incidents/v1/{incident_id}/events": { "get": { "description": "Retrieve a chronological list of all events associated with a specific incident. Includes state changes, assignments, acknowledgments, and resolutions.\n\nRequires the following permissions:\n- `incidents:read`", "operationId": "IncidentsService_GetIncidentEvents", "parameters": [ { "description": "ID of the incident to retrieve events for", "in": "path", "name": "incident_id", "required": true, "schema": { "description": "ID of the incident to retrieve events for", "examples": [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301" ], "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", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIncidentEventsResponse" } } }, "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 incident events", "tags": [ "Incidents service" ], "x-coralogixPermissions": [ "incidents:read" ] } }, "/integrations/contextual-data/v1": { "get": { "description": "Returns all contextual data integrations for the team.\n\nRequires the following permissions:\n- `contextual-data:ReadConfig`", "operationId": "ContextualDataIntegrationService_GetContextualDataIntegrations", "parameters": [ { "description": "Whether to include testing integrations in the results.", "in": "query", "name": "include_testing_integrations", "required": false, "schema": { "description": "Whether to include testing integrations in the results.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContextualDataIntegrationsResponse" } } }, "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 all contextual data integrations accessible", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:ReadConfig" ] }, "put": { "description": "Updates an existing contextual data integration.\n\nRequires the following permissions:\n- `contextual-data:UpdateConfig`", "operationId": "ContextualDataIntegrationService_UpdateContextualDataIntegration", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for updating a contextual data integration.", "properties": { "integrationId": { "description": "ID of the contextual data integration to update.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "title": "Update contextual data integration request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContextualDataIntegrationResponse" } } }, "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 contextual data integration", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:UpdateConfig" ] }, "post": { "description": "Creates a new contextual data integration.\n\nRequires the following permissions:\n- `contextual-data:UpdateConfig`", "operationId": "ContextualDataIntegrationService_SaveContextualDataIntegration", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for creating a contextual data integration.", "properties": { "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "title": "Save contextual data integration request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveContextualDataIntegrationResponse" } } }, "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": "Save contextual data integration", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:UpdateConfig" ] } }, "/integrations/contextual-data/v1/definitions/{id}": { "get": { "description": "Returns the definition for the specified contextual data integration type.\n\nRequires the following permissions:\n- `contextual-data:ReadConfig`", "operationId": "ContextualDataIntegrationService_GetContextualDataIntegrationDefinition", "parameters": [ { "description": "The unique identifier of the contextual data integration definition.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the contextual data integration definition.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Whether to include testing integrations in the results.", "in": "query", "name": "include_testing_integrations", "required": false, "schema": { "description": "Whether to include testing integrations in the results.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContextualDataIntegrationDefinitionResponse" } } }, "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 contextual data integration definition", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:ReadConfig" ] } }, "/integrations/contextual-data/v1/test/{integration_id}": { "post": { "description": "Tests the specified contextual data integration.\n\nRequires the following permissions:\n- `contextual-data:UpdateConfig`", "operationId": "ContextualDataIntegrationService_TestContextualDataIntegration", "parameters": [ { "description": "The unique identifier of the contextual data integration to test.", "in": "path", "name": "integration_id", "required": true, "schema": { "description": "The unique identifier of the contextual data integration to test.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing a contextual data integration.", "properties": { "integrationData": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "title": "Test contextual data integration request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestContextualDataIntegrationResponse" } } }, "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": "Test contextual data integration", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:UpdateConfig" ] } }, "/integrations/contextual-data/v1/{id}": { "get": { "description": "Returns the details of the specified contextual data integration.\n\nRequires the following permissions:\n- `contextual-data:ReadConfig`", "operationId": "ContextualDataIntegrationService_GetContextualDataIntegrationDetails", "parameters": [ { "description": "The unique identifier of the contextual data integration.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the contextual data integration.", "examples": [ "076f4188-05e0-4ed3-afeb-653ad182ccb7" ], "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Whether to include testing revisions in the results.", "in": "query", "name": "include_testing_revisions", "required": false, "schema": { "description": "Whether to include testing revisions in the results.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetContextualDataIntegrationDetailsResponse" } } }, "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 contextual data integration details", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:ReadConfig" ] }, "delete": { "description": "Deletes the specified contextual data integration.\n\nRequires the following permissions:\n- `contextual-data:UpdateConfig`", "operationId": "ContextualDataIntegrationService_DeleteContextualDataIntegration", "parameters": [ { "description": "The integration id.", "in": "path", "name": "id", "required": true, "schema": { "description": "The integration id.", "examples": [ "076f4188-05e0-4ed3-afeb-653ad182ccb7" ], "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteContextualDataIntegrationResponse" } } }, "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": "Delete contextual data integration", "tags": [ "Contextual data integration service" ], "x-coralogixPermissions": [ "contextual-data:UpdateConfig" ] } }, "/integrations/extensions/v1": { "post": { "description": "Creates a new extension.\n\nRequires the following permissions:\n- `extensions:ReadConfig`", "operationId": "ExtensionService_GetAllExtensions", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to list all extensions", "properties": { "filter": { "$ref": "#/components/schemas/GetAllExtensionsRequest.Filter" }, "includeHiddenExtensions": { "default": false, "description": "Whether to include hidden extensions that are not publicly listed in the catalog.", "type": "boolean", "x-coralogix-presence": true } }, "title": "Get all extensions request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllExtensionsResponse" } } }, "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 all extensions", "tags": [ "Extension service" ], "x-coralogixPermissions": [ "extensions:ReadConfig" ] } }, "/integrations/extensions/v1/catalog/{id}": { "get": { "description": "Returns the details of the specified extension.\n\nRequires the following permissions:\n- `extensions:ReadConfig`", "operationId": "ExtensionService_GetExtension", "parameters": [ { "description": "Unique identifier.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Whether to include dashboard binaries in the response.", "in": "query", "name": "include_dashboard_binaries", "required": false, "schema": { "default": false, "description": "Whether to include dashboard binaries in the response.", "type": "boolean", "x-coralogix-presence": true } }, { "description": "Whether to include testing revisions in the response.", "in": "query", "name": "include_testing_revision", "required": false, "schema": { "default": false, "description": "Whether to include testing revisions in the response.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1.Extension" } } }, "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 extension by ID", "tags": [ "Extension service" ], "x-coralogixPermissions": [ "extensions:ReadConfig" ] } }, "/integrations/extensions/v1/deployed": { "get": { "description": "Returns all deployed extensions.\n\nRequires the following permissions:\n- `extensions:ReadConfig`", "operationId": "ExtensionDeploymentService_GetDeployedExtensions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeployedExtensionsResponse" } } }, "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 deployed extensions", "tags": [ "Extension deployment service" ], "x-coralogixPermissions": [ "extensions:ReadConfig" ] }, "put": { "description": "Deploys an extension.\n\nRequires the following permissions:\n- `extensions:Deploy`", "operationId": "ExtensionDeploymentService_DeployExtension", "parameters": [ { "description": "Unique identifier.", "in": "query", "name": "id", "required": false, "schema": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Version number.", "in": "query", "name": "version", "required": false, "schema": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "The item ids.", "in": "query", "name": "item_ids", "required": false, "schema": { "default": [], "description": "The item ids.", "items": { "description": "The item ids.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The applications.", "in": "query", "name": "applications", "required": false, "schema": { "default": [], "description": "The applications.", "items": { "description": "The applications.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The subsystems.", "in": "query", "name": "subsystems", "required": false, "schema": { "default": [], "description": "The subsystems.", "items": { "description": "The subsystems.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The extension deployment configuration.", "in": "query", "name": "extension_deployment", "required": false, "schema": { "description": "Extension deployment.", "properties": { "applications": { "default": [], "description": "The applications.", "items": { "description": "The applications.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "itemIds": { "default": [], "description": "The item ids.", "items": { "description": "The item ids.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "subsystems": { "default": [], "description": "The subsystems.", "items": { "description": "The subsystems.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Extension deployment", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeployExtensionResponse" } } }, "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": "Deploy extension", "tags": [ "Extension deployment service" ], "x-coralogixPermissions": [ "extensions:Deploy" ] }, "post": { "description": "Updates a deployed extension.\n\nRequires the following permissions:\n- `extensions:Deploy`", "operationId": "ExtensionDeploymentService_UpdateExtension", "parameters": [ { "description": "Unique identifier.", "in": "query", "name": "id", "required": false, "schema": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Version number.", "in": "query", "name": "version", "required": false, "schema": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "The item ids.", "in": "query", "name": "item_ids", "required": false, "schema": { "default": [], "description": "The item ids.", "items": { "description": "The item ids.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The applications.", "in": "query", "name": "applications", "required": false, "schema": { "default": [], "description": "The applications.", "items": { "description": "The applications.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The subsystems.", "in": "query", "name": "subsystems", "required": false, "schema": { "default": [], "description": "The subsystems.", "items": { "description": "The subsystems.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, { "description": "The extension deployment configuration to update.", "in": "query", "name": "extension_deployment", "required": false, "schema": { "description": "Extension deployment.", "properties": { "applications": { "default": [], "description": "The applications.", "items": { "description": "The applications.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "itemIds": { "default": [], "description": "The item ids.", "items": { "description": "The item ids.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "subsystems": { "default": [], "description": "The subsystems.", "items": { "description": "The subsystems.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Extension deployment", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExtensionResponse" } } }, "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 extension", "tags": [ "Extension deployment service" ], "x-coralogixPermissions": [ "extensions:Deploy" ] }, "delete": { "description": "Undeploys the specified extension.\n\nRequires the following permissions:\n- `extensions:Deploy`", "operationId": "ExtensionDeploymentService_UndeployExtension", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for undeploying an extension.", "properties": { "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "keptExtensionItems": { "default": [], "description": "List of extension item IDs to retain after undeploying; all other items will be removed.", "items": { "description": "List of extension item IDs to retain after undeploying; all other items will be removed.", "minLength": 0, "type": "string" }, "maxItems": 10000, "minItems": 0, "type": "array" } }, "title": "Revert deployment of extension request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UndeployExtensionResponse" } } }, "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": "Revert deployment of extension", "tags": [ "Extension deployment service" ], "x-coralogixPermissions": [ "extensions:Deploy" ] } }, "/integrations/integrations/v1": { "get": { "description": "Returns all available integration definitions.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetIntegrations", "parameters": [ { "description": "Whether to include testing revisions in the response.", "in": "query", "name": "include_testing_revision", "required": false, "schema": { "description": "Whether to include testing revisions in the response.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationsResponse" } } }, "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 all integrations", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/integrations/v1/definitions/{id}": { "get": { "description": "Returns the definition for the specified integration type.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetIntegrationDefinition", "parameters": [ { "description": "The unique identifier of the integration definition.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the integration definition.", "examples": [ "aws-sqs" ], "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Whether to include testing revisions in the response.", "in": "query", "name": "include_testing_revision", "required": false, "schema": { "description": "Whether to include testing revisions in the response.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationDefinitionResponse" } } }, "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 integration definition", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/integrations/v1/deployed/{integration_id}": { "get": { "description": "Returns the deployed instance of the specified integration. An id that does not exist answers 404.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetDeployedIntegration", "parameters": [ { "description": "The integration id.", "in": "path", "name": "integration_id", "required": true, "schema": { "description": "The integration id.", "examples": [ "aws-sqs" ], "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeployedIntegrationResponse" } } }, "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 deployed integration", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/integrations/v1/instances/{integration_id}": { "delete": { "description": "Removes the specified deployed integration instance and answers an empty object. An id that does not exist answers 404.\n\nRequires the following permissions:\n- `integrations:Deploy`", "operationId": "IntegrationService_DeleteIntegration", "parameters": [ { "description": "The unique identifier of the integration instance to delete.", "in": "path", "name": "integration_id", "required": true, "schema": { "description": "The unique identifier of the integration instance to delete.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteIntegrationResponse" } } }, "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": "Delete integration", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:Deploy" ] } }, "/integrations/integrations/v1/rum/app-versions": { "get": { "description": "Returns RUM application version data.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetRumApplicationVersionData", "parameters": [ { "description": "The name of the RUM application to fetch version data for.", "in": "query", "name": "application_name", "required": false, "schema": { "description": "The name of the RUM application to fetch version data for.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRumApplicationVersionDataResponse" } } }, "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 RUM integration versions data", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/integrations/v1/rum/sync": { "post": { "description": "Syncs RUM data for the team.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_SyncRumData", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for syncing RUM data.", "properties": { "force": { "description": "The force.", "type": "boolean", "x-coralogix-presence": true } }, "title": "Sync RUM data request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncRumDataResponse" } } }, "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": "Trigger sync of RUM integration data", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/integrations/v1/{id}": { "get": { "description": "Returns the details of the specified integration.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetIntegrationDetails", "parameters": [ { "description": "The unique identifier of the integration.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the integration.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Whether to include testing revisions in the response.", "in": "query", "name": "include_testing_revision", "required": false, "schema": { "description": "Whether to include testing revisions in the response.", "type": "boolean", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationDetailsResponse" } } }, "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 integration details", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/managed/v1": { "get": { "description": "Returns a list of managed integration keys.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_ListManagedIntegrationKeys", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListManagedIntegrationKeysResponse" } } }, "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 managed integration keys", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/managed/v1/{integration_id}": { "get": { "description": "Returns the status of the specified managed integration.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetManagedIntegrationStatus", "parameters": [ { "description": "The unique identifier of the managed integration.", "in": "path", "name": "integration_id", "required": true, "schema": { "description": "The unique identifier of the managed integration.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagedIntegrationStatusResponse" } } }, "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 managed integration status", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/metadata/v1": { "put": { "description": "Updates the integration deployment with the given id and answers an empty object. A parameter that the request omits keeps its stored value. An id that does not exist answers 404.\n\nRequires the following permissions:\n- `integrations:Deploy`", "operationId": "IntegrationService_UpdateIntegration", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for updating an integration deployment.", "properties": { "id": { "description": "Integration metadata ID generated at creation time.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "required": [ "id", "metadata" ], "title": "Update integration request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIntegrationResponse" } } }, "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 integration", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:Deploy" ] }, "post": { "description": "Creates an integration deployment and returns its id. To change an existing deployment, use the update operation. Parameter names are case sensitive.\n\nRequires the following permissions:\n- `integrations:Deploy`", "operationId": "IntegrationService_SaveIntegration", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for creating an integration deployment.", "properties": { "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "required": [ "metadata" ], "title": "Save integration request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveIntegrationResponse" } } }, "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": "Save integration registration metadata", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:Deploy" ] } }, "/integrations/metadata/v1/test": { "post": { "description": "Tests the integration configuration. A test that runs answers 200 with result.success or result.failure.errorMessage. An invalid integration key or version answers 400 or 404.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_TestIntegration", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing an integration configuration.", "properties": { "integrationData": { "$ref": "#/components/schemas/IntegrationMetadata" }, "integrationId": { "description": "ID of the existing integration instance to test.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "integrationData" ], "title": "Test integration request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestIntegrationResponse" } } }, "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": "Test integration", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/template/v1": { "get": { "description": "Returns the template for an integration.\n\nRequires the following permissions:\n- `integrations:ReadConfig`", "operationId": "IntegrationService_GetTemplate", "parameters": [ { "description": "The unique identifier of the integration to fetch a template for.", "in": "query", "name": "integration_id", "required": false, "schema": { "description": "The unique identifier of the integration to fetch a template for.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Common ARM integration parameters (logs URL, API key, cgx domain) supplied when rendering the template.", "in": "query", "name": "common_arm_params", "required": false, "schema": { "properties": { "apiKey": { "description": "API key used to authenticate requests for template access.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "cgxDomain": { "description": "The cgx domain.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "logsUrl": { "description": "The logs url.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "title": "Common ARM integration parameters", "type": "object" } }, { "description": "Empty extra parameters; use when the template does not require additional inputs.", "in": "query", "name": "empty", "required": false, "schema": { "additionalProperties": false, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTemplateResponse" } } }, "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 integration template", "tags": [ "Integration service" ], "x-coralogixPermissions": [ "integrations:ReadConfig" ] } }, "/integrations/webhook-types/v1": { "get": { "description": "Returns all available outgoing webhook types.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_ListOutgoingWebhookTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOutgoingWebhookTypesResponse" } } }, "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 outgoing webhook types", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] } }, "/integrations/webhook-types/v1/{type}": { "get": { "description": "Returns the details for the specified outgoing webhook type.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_GetOutgoingWebhookTypeDetails", "parameters": [ { "description": "The outgoing webhook type to fetch details for.", "in": "path", "name": "type", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "description": "The outgoing webhook type to fetch details for." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOutgoingWebhookTypeDetailsResponse" } } }, "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 outgoing webhook type details", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] } }, "/integrations/webhooks-test/v1": { "post": { "description": "Tests an outgoing webhook configuration.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_TestOutgoingWebhook", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing an outgoing webhook configuration.", "properties": { "data": { "$ref": "#/components/schemas/OutgoingWebhookInputData" } }, "required": [ "data" ], "title": "Test outgoing webhook request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestOutgoingWebhookResponse" } } }, "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": "Test an outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] } }, "/integrations/webhooks/v1": { "get": { "description": "Returns all outgoing webhooks for the team.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_ListAllOutgoingWebhooks", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllOutgoingWebhooksResponse" } } }, "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 all outgoing webhooks", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] }, "put": { "description": "Updates an existing outgoing webhook.\n\nRequires the following permissions:\n- `outbound-webhooks:UpdateConfig`", "operationId": "OutgoingWebhooksService_UpdateOutgoingWebhook", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for updating an outgoing webhook.", "properties": { "data": { "$ref": "#/components/schemas/OutgoingWebhookInputData" }, "id": { "description": "Unique identifier.", "examples": [ "example_id" ], "minLength": 1, "type": "string" } }, "required": [ "id", "data" ], "title": "Update outgoing webhook request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutgoingWebhookResponse" } } }, "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 an outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:UpdateConfig" ] }, "post": { "description": "Creates a new outgoing webhook.\n\nRequires the following permissions:\n- `outbound-webhooks:UpdateConfig`", "operationId": "OutgoingWebhooksService_CreateOutgoingWebhook", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for creating an outgoing webhook.", "properties": { "data": { "$ref": "#/components/schemas/OutgoingWebhookInputData" } }, "required": [ "data" ], "title": "Create outgoing webhook request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutgoingWebhookResponse" } } }, "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": "Create an outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:UpdateConfig" ] } }, "/integrations/webhooks/v1/list/by-types": { "get": { "description": "Returns outgoing webhooks grouped by type.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_ListOutgoingWebhooks", "parameters": [ { "description": "The outgoing webhook type to filter the listing by.", "in": "query", "name": "type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "description": "The outgoing webhook type to filter the listing by." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOutgoingWebhooksResponse" } } }, "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 outgoing webhooks", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] } }, "/integrations/webhooks/v1/list/summaries": { "get": { "description": "Returns summary information for all outgoing webhooks.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadSummary`", "operationId": "OutgoingWebhooksService_ListOutboundWebhooksSummary", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOutboundWebhooksSummaryResponse" } } }, "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 outbound webhooks summary", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadSummary" ] } }, "/integrations/webhooks/v1/{id}": { "get": { "description": "Returns the details of the specified outgoing webhook.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_GetOutgoingWebhook", "parameters": [ { "description": "The unique identifier of the outgoing webhook.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the outgoing webhook.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOutgoingWebhookResponse" } } }, "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 outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] }, "delete": { "description": "Deletes the outgoing webhook with the specified ID.\n\nRequires the following permissions:\n- `outbound-webhooks:UpdateConfig`", "operationId": "OutgoingWebhooksService_DeleteOutgoingWebhook", "parameters": [ { "$ref": "#/components/parameters/id_4" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOutgoingWebhookResponse" } } }, "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": "Delete an outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:UpdateConfig" ] } }, "/integrations/webhooks/v1/{id}/test": { "get": { "description": "Tests the specified outgoing webhook.\n\nRequires the following permissions:\n- `outbound-webhooks:ReadConfig`", "operationId": "OutgoingWebhooksService_TestExistingOutgoingWebhook", "parameters": [ { "$ref": "#/components/parameters/id_4" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestOutgoingWebhookResponse" } } }, "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": "Test an existing outgoing webhook", "tags": [ "Outgoing webhooks service" ], "x-coralogixPermissions": [ "outbound-webhooks:ReadConfig" ] } }, "/logs/data-setup/v2": { "get": { "description": "Returns the current log archive target configuration.", "operationId": "S3TargetService_GetTarget", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/S3TargetServiceGetTargetResponse" } } }, "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 target", "tags": [ "Target Service" ] }, "post": { "description": "Sets the log archive target configuration.", "operationId": "S3TargetService_SetTarget", "requestBody": { "content": { "application/json": { "schema": { "properties": { "format": { "$ref": "#/components/schemas/TargetFormat" }, "isActive": { "description": "Whether archiving to this target is active.", "examples": [ true ], "type": "boolean" }, "s3": { "$ref": "#/components/schemas/S3TargetSpec" } }, "required": [ "isActive", "s3" ], "title": "Set Target Response", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/S3TargetServiceSetTargetResponse" } } }, "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": "Set target", "tags": [ "Target Service" ] } }, "/metrics/data-setup/v1": { "get": { "description": "Returns the current metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_GetTenantConfig", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTenantConfigResponseV2" } } }, "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 Metrics Storage Configuration", "tags": [ "Metrics Data Archive Service" ] }, "put": { "description": "Updates the metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_Update", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" } ] }, "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": { "description": "Archive retention period in days.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "s3": { "allOf": [ { "$ref": "#/components/schemas/S3Config" } ], "description": "AWS S3 storage configuration." } }, "title": "Update Tenant Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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 Metrics Storage Configuration", "tags": [ "Metrics Data Archive Service" ] }, "post": { "description": "Creates the metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_ConfigureTenant", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" } ] }, "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." } }, "title": "Configure Tenant Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "Configure Tenant", "tags": [ "Metrics Data Archive Service" ] } }, "/metrics/data-setup/v1/disable": { "post": { "description": "Disables the metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_DisableArchive", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "Disable Metrics Archive", "tags": [ "Metrics Data Archive Service" ] } }, "/metrics/data-setup/v1/enable": { "post": { "description": "Enables the metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_EnableArchive", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "Enable Metrics Archive", "tags": [ "Metrics Data Archive Service" ] } }, "/metrics/data-setup/v1/validate": { "post": { "description": "Validates the provided metrics storage configuration.", "operationId": "MetricsConfiguratorPublicService_ValidateBucket", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "ibm" ], "type": "object" }, { "required": [ "s3" ], "type": "object" }, { "required": [ "gcs" ], "type": "object" } ] }, "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." } }, "title": "Bucket Validation Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "Validate Metrics Storage Bucket", "tags": [ "Metrics Data Archive Service" ] } }, "/notifications/notification-center/v1/connector-schemas": { "get": { "description": "Returns the schema definition for notification connectors.", "operationId": "ConnectorSchemaService_GetConnectorSchema", "parameters": [ { "description": "Connector type whose schema to retrieve.", "in": "query", "name": "type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "Connector type whose schema to retrieve." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectorSchemaResponse" } } }, "description": "" } }, "summary": "Get Connector Schema", "tags": [ "Connector Schema service" ] } }, "/notifications/notification-center/v1/connectors": { "get": { "description": "Returns notification connectors with optional pagination.", "operationId": "ConnectorsService_ListConnectors", "parameters": [ { "description": "Filter connectors by their type.", "in": "query", "name": "connector_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "Filter connectors by their type.", "x-coralogix-presence": true } }, { "description": "Filter connectors by the entity type they support.", "in": "query", "name": "supported_by_entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Filter connectors by the entity type they support.", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConnectorsResponse" } } }, "description": "" } }, "summary": "List Connectors", "tags": [ "Connectors service" ] }, "put": { "description": "Updates an existing notification connector.", "operationId": "ConnectorsService_ReplaceConnector", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to replace an existing connector", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } }, "required": [ "connector" ], "title": "Replace Connector Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceConnectorResponse" } } }, "description": "" } }, "summary": "Replace a Connector", "tags": [ "Connectors service" ] }, "post": { "description": "Creates a new notification connector.", "operationId": "ConnectorsService_CreateConnector", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new connector", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } }, "required": [ "connector" ], "title": "Create Connector Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectorResponse" } } }, "description": "" } }, "summary": "Create a Connector", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors/all/list": { "get": { "description": "Returns all notification connectors for the team.", "operationId": "ConnectorsService_BatchGetConnectors", "parameters": [ { "description": "The unique identifiers of the connectors to retrieve.", "in": "query", "name": "connector_ids", "required": false, "schema": { "description": "The unique identifiers of the connectors to retrieve.", "examples": [ [ "connector-id-1", "connector-id-2" ] ], "items": { "description": "The unique identifiers of the connectors to retrieve.", "minLength": 0, "type": "string" }, "maxItems": 800, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetConnectorsResponse" } } }, "description": "" } }, "summary": "Batch Get Connectors", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors/all/summaries": { "get": { "description": "Returns summary information for all notification connectors.", "operationId": "ConnectorsService_BatchGetConnectorSummaries", "parameters": [ { "description": "The unique identifiers of the connectors whose summaries to retrieve.", "in": "query", "name": "connector_ids", "required": false, "schema": { "description": "The unique identifiers of the connectors whose summaries to retrieve.", "items": { "description": "The unique identifiers of the connectors whose summaries to retrieve.", "minLength": 0, "type": "string" }, "maxItems": 800, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetConnectorSummariesResponse" } } }, "description": "" } }, "summary": "Batch Get Connectors Summaries", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors/list/summaries": { "get": { "description": "Returns a paginated list of notification connector summaries.", "operationId": "ConnectorsService_ListConnectorSummaries", "parameters": [ { "description": "Filter connector summaries by their type.", "in": "query", "name": "connector_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "Filter connector summaries by their type.", "x-coralogix-presence": true } }, { "description": "Filter connector summaries by the entity type they support.", "in": "query", "name": "supported_by_entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Filter connector summaries by the entity type they support.", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConnectorSummariesResponse" } } }, "description": "" } }, "summary": "List Connector Summaries", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors/types/summaries": { "get": { "description": "Returns summary information for all available connector types.", "operationId": "ConnectorsService_GetConnectorTypeSummaries", "parameters": [ { "description": "Filter connector types by the entity type they support.", "in": "query", "name": "supported_by_entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Filter connector types by the entity type they support.", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectorTypeSummariesResponse" } } }, "description": "" } }, "summary": "Get Connector Type Summaries", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors/{id}": { "get": { "description": "Returns the details of the specified notification connector.", "operationId": "ConnectorsService_GetConnector", "parameters": [ { "description": "The unique identifier of the connector.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the connector.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectorResponse" } } }, "description": "" } }, "summary": "Get a Connector", "tags": [ "Connectors service" ] }, "delete": { "description": "Deletes the notification connector with the specified ID.", "operationId": "ConnectorsService_DeleteConnector", "parameters": [ { "$ref": "#/components/parameters/id_5" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectorResponse" } } }, "description": "" } }, "summary": "Delete a Connector", "tags": [ "Connectors service" ] } }, "/notifications/notification-center/v1/connectors:test": { "post": { "description": "Sends a test notification.", "operationId": "TestingService_TestExistingConnector", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for sending a test notification.", "properties": { "connectorId": { "description": "The connector id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" }, "payloadType": { "description": "Payload type to use when testing the connector.", "examples": [ "default" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestExistingConnectorResponse" } } }, "description": "" } }, "summary": "Test Existing Connector", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/connectors:testConfig": { "post": { "description": "Tests a notification connector configuration.", "operationId": "TestingService_TestConnectorConfig", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to test a connector configuration", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ], "x-coralogix-presence": true }, "fields": { "description": "Fields.", "items": { "$ref": "#/components/schemas/notification_center.ConnectorConfigField" }, "maxItems": 100, "minItems": 0, "type": "array" }, "payloadType": { "description": "Payload type to use when testing the connector.", "examples": [ "default" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "type": { "$ref": "#/components/schemas/notification_center.ConnectorType" } }, "title": "Test Connector Config Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectorConfigResponse" } } }, "description": "" } }, "summary": "Test Connector Config", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/destinations:test": { "post": { "description": "Tests a notification destination.", "operationId": "TestingService_TestDestination", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing a notification destination.", "properties": { "connectorConfigFields": { "description": "The connector config fields.", "items": { "$ref": "#/components/schemas/TemplatedConnectorConfigField" }, "maxItems": 100, "minItems": 0, "type": "array" }, "connectorId": { "description": "The connector id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" }, "entitySubType": { "description": "Entity sub-type to use when testing the destination.", "examples": [ "logsImmediateResolved" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "messageConfigFields": { "description": "The message config fields.", "items": { "$ref": "#/components/schemas/notification_center.MessageConfigField" }, "maxItems": 100, "minItems": 0, "type": "array" }, "payloadType": { "description": "Payload type to use when testing the destination.", "examples": [ "default" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "presetId": { "description": "The preset id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestDestinationResponse" } } }, "description": "" } }, "summary": "Test Destination", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/entity-types": { "get": { "description": "Returns all available notification entity types.", "operationId": "EntitiesService_ListEntityTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEntityTypesResponse" } } }, "description": "" } }, "summary": "List Entity Types", "tags": [ "Entities service" ] } }, "/notifications/notification-center/v1/entity-types/{entity_type}/attachment-types": { "get": { "description": "Returns all supported attachment types for the specified entity type.", "operationId": "EntitiesService_ListEntityTypeAttachmentTypes", "parameters": [ { "description": "Entity type whose supported attachment types to list.", "in": "path", "name": "entity_type", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Entity type whose supported attachment types to list." } } ], "responses": { "200": { "content": { "application/json": { "example": { "supportedAttachmentTypes": [ { "defaultEnabled": true, "name": "alert_graph" }, { "defaultEnabled": false, "name": "log_example" } ] }, "schema": { "$ref": "#/components/schemas/ListEntityTypeAttachmentTypesResponse" } } }, "description": "" } }, "summary": "List Entity Type Attachment Types", "tags": [ "Entities service" ] } }, "/notifications/notification-center/v1/entity-types/{entity_type}/entity-subtypes": { "get": { "description": "Returns all sub-types for the specified entity type.", "operationId": "EntitiesService_ListEntitySubTypes", "parameters": [ { "description": "Entity type whose sub-types to list.", "in": "path", "name": "entity_type", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Entity type whose sub-types to list." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEntitySubTypesResponse" } } }, "description": "" } }, "summary": "List Entity Subtypes", "tags": [ "Entities service" ] } }, "/notifications/notification-center/v1/presets": { "get": { "description": "Returns all notification presets.", "operationId": "PresetsService_BatchGetPresets", "parameters": [ { "description": "The unique identifiers of the presets to retrieve.", "in": "query", "name": "preset_ids", "required": false, "schema": { "description": "The unique identifiers of the presets to retrieve.", "items": { "description": "The unique identifiers of the presets to retrieve.", "minLength": 0, "type": "string" }, "maxItems": 600, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetPresetsResponse" } } }, "description": "" } }, "summary": "Batch Get Presets", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets/custom/{id}": { "delete": { "description": "Deletes the custom notification preset with the specified ID.", "operationId": "PresetsService_DeleteCustomPreset", "parameters": [ { "$ref": "#/components/parameters/id_5" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCustomPresetResponse" } } }, "description": "" } }, "summary": "Delete Custom Preset", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets/custom/{id}/default": { "post": { "description": "Sets a custom preset as the default.", "operationId": "PresetsService_SetCustomPresetAsDefault", "parameters": [ { "description": "The unique identifier of the custom preset to set as default.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the custom preset to set as default.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCustomPresetAsDefaultResponse" } } }, "description": "" } }, "summary": "Set Custom Preset As Default", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets/summaries/system": { "get": { "description": "Returns summaries for all system-defined notification presets.", "operationId": "PresetsService_GetSystemDefaultPresetSummary", "parameters": [ { "description": "The connector type whose system default preset summary is requested.", "in": "query", "name": "connector_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "The connector type whose system default preset summary is requested." } }, { "description": "The entity type whose system default preset summary is requested.", "in": "query", "name": "entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "The entity type whose system default preset summary is requested.", "examples": [ "ALERTS" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSystemDefaultPresetSummaryResponse" } } }, "description": "" } }, "summary": "Get System Default Preset Summary", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets/{id}": { "get": { "description": "Returns the details of the specified notification preset.", "operationId": "PresetsService_GetPreset", "parameters": [ { "description": "The unique identifier of the preset to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the preset to retrieve.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPresetResponse" } } }, "description": "" } }, "summary": "Get Preset", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets/{id}/default/apply": { "post": { "description": "Sets the specified preset as the default for an entity.", "operationId": "PresetsService_SetPresetAsDefault", "parameters": [ { "description": "The unique identifier of the preset to set as default.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the preset to set as default.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPresetAsDefaultResponse" } } }, "description": "" } }, "summary": "Set Preset As Default", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets:createCustom": { "post": { "description": "Creates a new custom notification preset.", "operationId": "PresetsService_CreateCustomPreset", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new custom preset", "properties": { "preset": { "$ref": "#/components/schemas/Preset" } }, "title": "Create Custom Preset Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomPresetResponse" } } }, "description": "" } }, "summary": "Create Custom Preset", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets:getDefaultSummary": { "get": { "description": "Returns a summary of the default notification preset.", "operationId": "PresetsService_GetDefaultPresetSummary", "parameters": [ { "description": "The connector type whose default preset summary is requested.", "in": "query", "name": "connector_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "The connector type whose default preset summary is requested." } }, { "description": "The entity type whose default preset summary is requested.", "in": "query", "name": "entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "The entity type whose default preset summary is requested.", "examples": [ "ALERTS" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDefaultPresetSummaryResponse" } } }, "description": "" } }, "summary": "Get Default Preset Summary", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets:replaceCustom": { "put": { "description": "Replaces an existing custom notification preset.", "operationId": "PresetsService_ReplaceCustomPreset", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to replace an existing custom preset", "properties": { "preset": { "$ref": "#/components/schemas/Preset" } }, "title": "Replace Custom Preset Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceCustomPresetResponse" } } }, "description": "" } }, "summary": "Replace Custom Preset", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets:summariesList": { "get": { "description": "Returns a list of notification preset summaries.", "operationId": "PresetsService_ListPresetSummaries", "parameters": [ { "description": "Filter preset summaries by their connector type.", "in": "query", "name": "connector_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.ConnectorType" } ], "description": "Filter preset summaries by their connector type.", "x-coralogix-presence": true } }, { "description": "Filter preset summaries by their entity type.", "in": "query", "name": "entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "description": "Filter preset summaries by their entity type.", "examples": [ "ALERTS" ], "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPresetSummariesResponse" } } }, "description": "" } }, "summary": "List Preset Summaries", "tags": [ "Presets service" ] } }, "/notifications/notification-center/v1/presets:test": { "post": { "description": "Tests an existing notification preset.", "operationId": "TestingService_TestExistingPreset", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing an existing notification preset.", "properties": { "connectorId": { "description": "The connector id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" }, "entitySubType": { "description": "Entity sub-type to use when testing the preset.", "examples": [ "logsImmediateResolved" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "presetId": { "description": "The preset id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestExistingPresetResponse" } } }, "description": "" } }, "summary": "Test Existing Preset", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/presets:testConfig": { "post": { "description": "Tests a notification preset configuration.", "operationId": "TestingService_TestPresetConfig", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing a notification preset configuration.", "properties": { "configOverrides": { "description": "The config overrides.", "items": { "$ref": "#/components/schemas/ConfigOverrides" }, "maxItems": 100, "minItems": 0, "type": "array" }, "connectorId": { "description": "The connector id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" }, "entitySubType": { "description": "Entity sub-type to use when testing the preset configuration.", "examples": [ "metric" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "parentPresetId": { "description": "The parent preset id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestPresetConfigResponse" } } }, "description": "" } }, "summary": "Test Preset Config", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/routers": { "get": { "description": "Returns all notification routers for the team.", "operationId": "GlobalRoutersService_ListGlobalRouters", "parameters": [ { "description": "Deprecated. Filter routers by entity type.", "in": "query", "name": "entity_type", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "deprecated": true, "description": "Deprecated. Filter routers by entity type.", "x-coralogix-presence": true } }, { "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.", "in": "query", "name": "source_entity_labels", "required": false, "schema": { "additionalProperties": { "properties": { "values": { "description": "The values.", "items": { "description": "The values.", "minLength": 0, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object" }, "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.", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListGlobalRoutersResponse" } } }, "description": "" } }, "summary": "List Global Routers", "tags": [ "Global routers service" ] }, "put": { "description": "Updates an existing notification router.", "operationId": "GlobalRoutersService_ReplaceGlobalRouter", "requestBody": { "content": { "application/json": { "schema": { "description": "Request which updates an existing global router", "properties": { "router": { "$ref": "#/components/schemas/GlobalRouter" } }, "required": [ "router" ], "title": "Replace Global Router Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceGlobalRouterResponse" } } }, "description": "" } }, "summary": "Replace Global Router", "tags": [ "Global routers service" ] }, "post": { "description": "Creates a new notification router.", "operationId": "GlobalRoutersService_CreateGlobalRouter", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a global router", "properties": { "router": { "$ref": "#/components/schemas/GlobalRouter" } }, "required": [ "router" ], "title": "Create Global Router Request", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalRouterResponse" } } }, "description": "" } }, "summary": "Create Global Router", "tags": [ "Global routers service" ] } }, "/notifications/notification-center/v1/routers/all/summaries": { "get": { "description": "Returns summary information for all notification routers.", "operationId": "GlobalRoutersService_BatchGetGlobalRouters", "parameters": [ { "description": "The unique identifiers of the global routers to retrieve summaries for.", "in": "query", "name": "global_router_ids", "required": false, "schema": { "description": "The unique identifiers of the global routers to retrieve summaries for.", "items": { "description": "The unique identifiers of the global routers to retrieve summaries for.", "minLength": 0, "type": "string" }, "maxItems": 200, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetGlobalRoutersResponse" } } }, "description": "" } }, "summary": "Batch Get Global Routers", "tags": [ "Global routers service" ] } }, "/notifications/notification-center/v1/routers/matcher/validate": { "post": { "description": "Validates a notification router matcher configuration.", "operationId": "GlobalRoutersService_ValidateEntityLabelMatcher", "parameters": [ { "description": "Entity label matcher to validate, expressed as a map of label keys to expected values.", "in": "query", "name": "entity_label_matcher", "required": false, "schema": { "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Entity label matcher to validate, expressed as a map of label keys to expected values.", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateEntityLabelMatcherResponse" } } }, "description": "" } }, "summary": "Validate Entity Label Matcher", "tags": [ "Global routers service" ] } }, "/notifications/notification-center/v1/routers/{id}": { "get": { "description": "Returns the details of the specified notification router.", "operationId": "GlobalRoutersService_GetGlobalRouter", "parameters": [ { "description": "The unique identifier of the global router to retrieve.", "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the global router to retrieve.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalRouterResponse" } } }, "description": "" } }, "summary": "Get Global Router", "tags": [ "Global routers service" ] }, "delete": { "description": "Deletes the notification router with the specified ID.", "operationId": "GlobalRoutersService_DeleteGlobalRouter", "parameters": [ { "$ref": "#/components/parameters/id_5" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGlobalRouterResponse" } } }, "description": "" } }, "summary": "Delete Global Router", "tags": [ "Global routers service" ] } }, "/notifications/notification-center/v1/routers:testCondition": { "post": { "description": "Tests notification routing conditions.", "operationId": "TestingService_TestRoutingConditionValid", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to check that provided routing condition is valid", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "template": { "description": "Routing condition expression to validate.", "examples": [ "alertDef.priority == 'P1'" ], "maxLength": 20000, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string" } }, "title": "Test Routing Condition Valid Request", "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestRoutingConditionValidResponse" } } }, "description": "" } }, "summary": "Test Routing Condition Valid", "tags": [ "Notifications testing service" ] } }, "/notifications/notification-center/v1/templates:test": { "post": { "description": "Tests the rendering of a notification template.", "operationId": "TestingService_TestTemplateRender", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for testing notification template rendering.", "properties": { "entitySubType": { "description": "Entity sub-type to use when testing template rendering.", "examples": [ "logsImmediateResolved" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "template": { "description": "Template string to test rendering for.", "examples": [ "{{ alertDef.name }}" ], "maxLength": 20000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestTemplateRenderResponse" } } }, "description": "" } }, "summary": "Test Template Render", "tags": [ "Notifications testing service" ] } }, "/parsing-rules/limits/v1": { "post": { "description": "Returns parsing rule usage limits.", "operationId": "RuleGroupsService_GetCompanyUsageLimits", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCompanyUsageLimitsResponse" } } }, "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 Company Usage Limits", "tags": [ "Rule Groups Service" ] } }, "/parsing-rules/mapping/v1": { "post": { "description": "Returns the model mapping for a parsing rule group.", "operationId": "RuleGroupsService_GetRuleGroupModelMapping", "requestBody": { "content": { "application/json": { "schema": { "description": "Request for retrieving the model mapping for a parsing rule group.", "properties": { "creator": { "description": "Creator.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Whether this resource is enabled.", "type": "boolean", "x-coralogix-presence": true }, "hidden": { "description": "Whether to hide this rule group from the standard view.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "order": { "description": "Sort order.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ruleMatchers": { "description": "List of rule matchers that determine which logs this group applies to.", "items": { "$ref": "#/components/schemas/RuleMatcher" }, "minItems": 0, "type": "array" }, "ruleSubgroups": { "description": "List of rule subgroups defining the ordered set of rules in this group.", "items": { "$ref": "#/components/schemas/GetRuleGroupModelMappingRequest.CreateRuleSubgroup" }, "minItems": 0, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRuleGroupModelMappingResponse" } } }, "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 Rule Group Model Mapping", "tags": [ "Rule Groups Service" ] } }, "/parsing-rules/rule-groups/v1": { "get": { "description": "Returns all parsing rule groups for the team.", "operationId": "RuleGroupsService_ListRuleGroups", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRuleGroupsResponse" } } }, "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 Rule Groups", "tags": [ "Rule Groups Service" ] }, "post": { "description": "Creates a new parsing rule group.", "operationId": "RuleGroupsService_CreateRuleGroup", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new parsing rule group. Update takes the same body and replaces the whole group: a field that the request omits takes its default.", "properties": { "creator": { "description": "Free-form name of the creator. The service stores it as sent. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the group is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "hidden": { "default": false, "description": "A free-form flag for clients, for example to hide the group in a UI. The service stores and returns it and does not act on it. Defaults to false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "order": { "default": 1, "description": "Position of the group among the rule groups of the company. Defaults to 1. 0 places the group last. Groups can share an order: the service does not shift the other groups.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ruleMatchers": { "description": "The rule matchers.", "items": { "$ref": "#/components/schemas/RuleMatcher" }, "minItems": 0, "type": "array" }, "ruleSubgroups": { "description": "The rule subgroups. At least one.", "items": { "$ref": "#/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup" }, "minItems": 1, "type": "array" }, "teamId": { "allOf": [ { "$ref": "#/components/schemas/v1.TeamId" } ], "description": "Ignored. The service takes the team from the credentials of the request." } }, "required": [ "name", "ruleSubgroups" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRuleGroupResponse" } } }, "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": "Create Rule Group", "tags": [ "Rule Groups Service" ] }, "delete": { "description": "Deletes all parsing rule groups.", "operationId": "RuleGroupsService_BulkDeleteRuleGroup", "parameters": [ { "description": "The unique identifiers of the parsing rule groups to delete.", "in": "query", "name": "group_ids", "required": false, "schema": { "description": "The unique identifiers of the parsing rule groups to delete.", "items": { "description": "The unique identifiers of the parsing rule groups to delete.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteRuleGroupResponse" } } }, "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": "Bulk Delete Rule Group", "tags": [ "Rule Groups Service" ] } }, "/parsing-rules/rule-groups/v1/{group_id}": { "get": { "description": "Returns the details of the specified parsing rule group.", "operationId": "RuleGroupsService_GetRuleGroup", "parameters": [ { "description": "The unique identifier of the parsing rule group to retrieve.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the parsing rule group to retrieve.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRuleGroupResponse" } } }, "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 Rule Group", "tags": [ "Rule Groups Service" ] }, "put": { "description": "Replaces the specified parsing rule group with the request body. A field that the request omits takes its default, and the service sets new ids for every subgroup and rule.", "operationId": "RuleGroupsService_UpdateRuleGroup", "parameters": [ { "description": "The unique identifier of the parsing rule group to update.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the parsing rule group to update.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request to create a new parsing rule group. Update takes the same body and replaces the whole group: a field that the request omits takes its default.", "properties": { "creator": { "description": "Free-form name of the creator. The service stores it as sent. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the group is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "hidden": { "default": false, "description": "A free-form flag for clients, for example to hide the group in a UI. The service stores and returns it and does not act on it. Defaults to false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "order": { "default": 1, "description": "Position of the group among the rule groups of the company. Defaults to 1. 0 places the group last. Groups can share an order: the service does not shift the other groups.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ruleMatchers": { "description": "The rule matchers.", "items": { "$ref": "#/components/schemas/RuleMatcher" }, "minItems": 0, "type": "array" }, "ruleSubgroups": { "description": "The rule subgroups. At least one.", "items": { "$ref": "#/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup" }, "minItems": 1, "type": "array" }, "teamId": { "allOf": [ { "$ref": "#/components/schemas/v1.TeamId" } ], "description": "Ignored. The service takes the team from the credentials of the request." } }, "required": [ "name", "ruleSubgroups" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRuleGroupResponse" } } }, "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 Rule Group", "tags": [ "Rule Groups Service" ] }, "delete": { "description": "Deletes the parsing rule group with the specified ID.", "operationId": "RuleGroupsService_DeleteRuleGroup", "parameters": [ { "description": "The unique identifier of the parsing rule group to delete.", "in": "path", "name": "group_id", "required": true, "schema": { "description": "The unique identifier of the parsing rule group to delete.", "minLength": 0, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRuleGroupResponse" } } }, "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": "Delete Rule Group", "tags": [ "Rule Groups Service" ] } }, "/recording-rules/recording-rules/v1": { "get": { "description": "Returns all recording rule groups for the team.", "operationId": "RuleGroupSets_List", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroupSetListing" } } }, "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 Recording Rules", "tags": [ "Recording Rules Service" ] }, "post": { "description": "Creates a set of recording rule groups and returns its id. A set name that another set has answers 400.", "operationId": "RuleGroupSets_Create", "requestBody": { "content": { "application/json": { "schema": { "description": "A set of rule groups to create.", "properties": { "groups": { "description": "The rule groups of the set. The service rejects an empty list. Group names are unique within the set. The server does not keep the order of the groups.", "items": { "$ref": "#/components/schemas/InRuleGroup" }, "maxItems": 1000, "minItems": 1, "type": "array", "x-coralogix-collection": "set" }, "name": { "description": "The name of the set. Unique among the sets of the company. When omitted, the server uses the id of the set.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "groups" ], "title": "Create Rule Group Set", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRuleGroupSetResult" } } }, "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": "Create Recording Rules", "tags": [ "Recording Rules Service" ] } }, "/recording-rules/recording-rules/v1/{id}": { "get": { "description": "Returns the set with the given id. An id that does not exist answers 404.", "operationId": "RuleGroupSets_Fetch", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutRuleGroupSet" } } }, "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": "No rule group set with the given id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Recording Rules", "tags": [ "Recording Rules Service" ] }, "put": { "description": "Replaces the groups of the set with the given id. An omitted name keeps the stored name. An id that does not exist answers 404.", "operationId": "RuleGroupSets_Update", "requestBody": { "content": { "application/json": { "schema": { "description": "A set of rule groups to update.", "properties": { "groups": { "description": "The rule groups of the set. The service rejects an empty list. Group names are unique within the set. The request replaces the stored groups: a stored group that the request omits is deleted, and a group with the name of a stored group keeps its id. The server does not keep the order of the groups.", "items": { "$ref": "#/components/schemas/InRuleGroup" }, "maxItems": 1000, "minItems": 1, "type": "array", "x-coralogix-collection": "set" }, "name": { "description": "The name of the set. Unique among the sets of the company. When omitted, the stored name stays.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "required": [ "groups" ], "title": "Update Rule Group Set", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "No rule group set with the given id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Update Recording Rules", "tags": [ "Recording Rules Service" ] }, "delete": { "description": "Deletes the set with the given id. An id that does not exist answers 404.", "operationId": "RuleGroupSets_Delete", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "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": "No rule group set with the given id" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Delete Recording Rules", "tags": [ "Recording Rules Service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Unique identifier." } } ] }, "/slo/slos/v1": { "get": { "description": "Returns SLOs matching the given criteria.", "operationId": "SlosService_ListSlos", "parameters": [ { "description": "The filters.", "in": "query", "name": "filters", "required": false, "schema": { "description": "The filters.", "items": { "description": "A filter for SLOs, consisting of a field and a predicate", "properties": { "field": { "description": "Field used for filtering SLOs", "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" }, { "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" } ] }, "type": "object" } ], "properties": { "constFilter": { "$ref": "#/components/schemas/SloConstantFilterField" }, "labelName": { "description": "Filter by a specific SLO label key.", "examples": [ "environment" ], "minLength": 0, "type": "string" }, "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": { "description": "Filter discriminator for SLO product type values.", "type": "boolean" }, "serviceName": { "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.", "examples": [ "payment-service" ], "minLength": 0, "type": "string" }, "sloType": { "description": "Filter discriminator for SLO type values.", "type": "boolean" } }, "title": "SloFilterField", "type": "object" }, "predicate": { "description": "Predicate used for filtering SLOs", "properties": { "is": { "description": "Predicate for SLO filters that checks if a field is equal to one of multiple values", "oneOf": [ { "required": [ "stringValues" ], "type": "object" }, { "required": [ "typeValues" ], "type": "object" }, { "required": [ "productTypeValues" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "stringValues" ], "type": "object" }, { "required": [ "typeValues" ], "type": "object" }, { "required": [ "productTypeValues" ], "type": "object" } ] }, "type": "object" } ], "properties": { "productTypeValues": { "$ref": "#/components/schemas/ProductTypeValues" }, "stringValues": { "$ref": "#/components/schemas/StringValues" }, "typeValues": { "$ref": "#/components/schemas/TypeValues" } }, "title": "IsFilterPredicate", "type": "object" } }, "title": "SloFilterPredicate", "type": "object" } }, "title": "SloFilter", "type": "object" }, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSlosResponse" } } }, "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 Slos", "tags": [ "Slos Service" ] }, "put": { "description": "Updates an existing SLO.", "operationId": "SlosService_ReplaceSlo", "parameters": [ { "description": "Whether to silence data validations.", "in": "query", "name": "silence_data_validations", "required": false, "schema": { "deprecated": true, "description": "Whether to silence data validations.", "type": "boolean", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Definition of an SLO", "oneOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" } ] }, "type": "object" } ], "properties": { "apmSli": { "$ref": "#/components/schemas/ApmSli" }, "apmSliMetadata": { "allOf": [ { "$ref": "#/components/schemas/ApmSli" } ], "description": "Server copy of apmSli for APM SLOs. Set by the server; sending it instead of apmSli is rejected.", "readOnly": true }, "createTime": { "description": "RFC3339 timestamp of when the SLO was created. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "creator": { "description": "Email or identifier of the user who created the SLO. Set by the server; a value sent by the client is ignored.", "examples": [ "test@domain.com" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of the SLO.", "examples": [ "A brief description of my SLO" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/v1.Grouping" } ], "description": "Grouping labels derived by the server from the SLI. A value sent by the client is rejected.", "readOnly": true }, "id": { "description": "Unique identifier of the SLO.", "examples": [ "b11919d5-ef85-4bb1-8655-02640dbe94d9" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "labels": { "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of labels.", "type": "object" }, "name": { "description": "Human-readable display name for the SLO. Required. A missing or empty name is rejected.", "examples": [ "Example Slo Name" ], "minLength": 1, "type": "string" }, "ownershipTags": { "allOf": [ { "$ref": "#/components/schemas/SloOwnershipTags" } ], "description": "Service, environment, and team ownership configuration for the SLO group and its permutations." }, "productType": { "allOf": [ { "$ref": "#/components/schemas/SloProductType" } ], "description": "Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs", "examples": [ "SLO_PRODUCT_TYPE_APM" ], "x-coralogix-presence": true }, "requestBasedMetricSli": { "$ref": "#/components/schemas/RequestBasedMetricSli" }, "revision": { "allOf": [ { "$ref": "#/components/schemas/v1.Revision" } ], "description": "Revision of the SLO. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "sloTimeFrame": { "allOf": [ { "$ref": "#/components/schemas/SloTimeFrame" } ], "description": "Rolling evaluation window (fixed-duration lookback)." }, "sloType": { "allOf": [ { "$ref": "#/components/schemas/SloType" } ], "description": "SLO type derived by the server from the SLI. A window-based metric SLI still reads SLO_TYPE_REQUEST. A value sent by the client must match the SLI type; a different value is rejected.", "examples": [ "SLO_TYPE_REQUEST" ], "readOnly": true, "x-coralogix-presence": true }, "targetThresholdPercentage": { "description": "Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).", "examples": [ 99.999 ], "format": "float", "type": "number" }, "type": { "deprecated": true, "description": "Deprecated: SLO type string. Set by the server from the SLI; a value sent by the client is ignored.", "examples": [ "request" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "windowBasedMetricSli": { "$ref": "#/components/schemas/WindowBasedMetricSli" } }, "required": [ "name", "sloTimeFrame" ], "title": "Slo", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceSloResponse" } } }, "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": "Replace Slo", "tags": [ "Slos Service" ] }, "post": { "description": "Creates a new SLO.", "operationId": "SlosService_CreateSlo", "parameters": [ { "description": "Whether to silence data validations.", "in": "query", "name": "silence_data_validations", "required": false, "schema": { "deprecated": true, "description": "Whether to silence data validations.", "type": "boolean", "x-coralogix-presence": true } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Definition of an SLO", "oneOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" } ] }, "type": "object" } ], "properties": { "apmSli": { "$ref": "#/components/schemas/ApmSli" }, "apmSliMetadata": { "allOf": [ { "$ref": "#/components/schemas/ApmSli" } ], "description": "Server copy of apmSli for APM SLOs. Set by the server; sending it instead of apmSli is rejected.", "readOnly": true }, "createTime": { "description": "RFC3339 timestamp of when the SLO was created. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "creator": { "description": "Email or identifier of the user who created the SLO. Set by the server; a value sent by the client is ignored.", "examples": [ "test@domain.com" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of the SLO.", "examples": [ "A brief description of my SLO" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/v1.Grouping" } ], "description": "Grouping labels derived by the server from the SLI. A value sent by the client is rejected.", "readOnly": true }, "id": { "description": "Unique identifier of the SLO.", "examples": [ "b11919d5-ef85-4bb1-8655-02640dbe94d9" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "labels": { "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of labels.", "type": "object" }, "name": { "description": "Human-readable display name for the SLO. Required. A missing or empty name is rejected.", "examples": [ "Example Slo Name" ], "minLength": 1, "type": "string" }, "ownershipTags": { "allOf": [ { "$ref": "#/components/schemas/SloOwnershipTags" } ], "description": "Service, environment, and team ownership configuration for the SLO group and its permutations." }, "productType": { "allOf": [ { "$ref": "#/components/schemas/SloProductType" } ], "description": "Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs", "examples": [ "SLO_PRODUCT_TYPE_APM" ], "x-coralogix-presence": true }, "requestBasedMetricSli": { "$ref": "#/components/schemas/RequestBasedMetricSli" }, "revision": { "allOf": [ { "$ref": "#/components/schemas/v1.Revision" } ], "description": "Revision of the SLO. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "sloTimeFrame": { "allOf": [ { "$ref": "#/components/schemas/SloTimeFrame" } ], "description": "Rolling evaluation window (fixed-duration lookback)." }, "sloType": { "allOf": [ { "$ref": "#/components/schemas/SloType" } ], "description": "SLO type derived by the server from the SLI. A window-based metric SLI still reads SLO_TYPE_REQUEST. A value sent by the client must match the SLI type; a different value is rejected.", "examples": [ "SLO_TYPE_REQUEST" ], "readOnly": true, "x-coralogix-presence": true }, "targetThresholdPercentage": { "description": "Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).", "examples": [ 99.999 ], "format": "float", "type": "number" }, "type": { "deprecated": true, "description": "Deprecated: SLO type string. Set by the server from the SLI; a value sent by the client is ignored.", "examples": [ "request" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "windowBasedMetricSli": { "$ref": "#/components/schemas/WindowBasedMetricSli" } }, "required": [ "name", "sloTimeFrame" ], "title": "Slo", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSloResponse" } } }, "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": "Create Slo", "tags": [ "Slos Service" ] } }, "/slo/slos/v1/all/execute": { "post": { "description": "Triggers execution for all SLOs.", "operationId": "SlosService_BatchExecuteSlo", "requestBody": { "content": { "application/json": { "schema": { "description": "Request to batch execute multiple SLO operations.", "properties": { "requests": { "description": "The requests.", "items": { "$ref": "#/components/schemas/SloExecutionRequest" }, "minItems": 0, "type": "array" } }, "required": [ "requests" ], "title": "BatchExecuteSloRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchExecuteSloResponse" } } }, "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": "Batch Execute Slo", "tags": [ "Slos Service" ] } }, "/slo/slos/v1/all/list": { "get": { "description": "Returns all SLOs for the team.", "operationId": "SlosService_BatchGetSlos", "parameters": [ { "description": "The ids.", "in": "query", "name": "ids", "required": true, "schema": { "description": "The ids.", "items": { "description": "The ids.", "minLength": 0, "type": "string" }, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchGetSlosResponse" } } }, "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": "Batch Get Slo", "tags": [ "Slos Service" ] } }, "/slo/slos/v1/{id}": { "get": { "description": "Returns the details of the specified SLO.", "operationId": "SlosService_GetSlo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSloResponse" } } }, "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 Slo", "tags": [ "Slos Service" ] }, "delete": { "description": "Deletes the SLO with the specified ID.", "operationId": "SlosService_DeleteSlo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSloResponse" } } }, "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": "Delete Slo", "tags": [ "Slos Service" ] }, "parameters": [ { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "minLength": 0, "type": "string", "description": "Unique identifier." } } ] }, "/slo/slos/v1/{id}/status": { "get": { "description": "Returns lowest compliance and remaining error budget (0-1 ratios) for an SLO grouping slice over a time window.", "operationId": "SlosService_GetSloStatus", "parameters": [ { "description": "Unique identifier of the SLO.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the SLO.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" } }, { "description": "Grouping label pairs that identify the slice to evaluate, passed as repeated query values. Each entry is one pair: the substring before the first comma is the label name (must not contain a comma), and the remainder of the entry (which may contain commas, or be empty) is the label value. Example: grouping_key_value=service,api&grouping_key_value=region,eu-west-1 or grouping_key_value=service, for an empty value. When omitted or empty, every permutation is considered. When provided, each label name must appear at most once and must be one of the SLO configured grouping labels; the slice includes every atomic permutation whose labels match the given pairs (a proper subset of grouping dimensions matches all permutations that agree on those labels). `lowestCompliance` and `lowestRemainingErrorBudget` are the minimum ratio across those matching permutations, not ratios recomputed from summed events across omitted dimensions.", "in": "query", "name": "grouping_key_value", "required": false, "schema": { "description": "Grouping label pairs that identify the slice to evaluate, passed as repeated query values. Each entry is one pair: the substring before the first comma is the label name (must not contain a comma), and the remainder of the entry (which may contain commas, or be empty) is the label value. Example: grouping_key_value=service,api&grouping_key_value=region,eu-west-1 or grouping_key_value=service, for an empty value. When omitted or empty, every permutation is considered. When provided, each label name must appear at most once and must be one of the SLO configured grouping labels; the slice includes every atomic permutation whose labels match the given pairs (a proper subset of grouping dimensions matches all permutations that agree on those labels). `lowestCompliance` and `lowestRemainingErrorBudget` are the minimum ratio across those matching permutations, not ratios recomputed from summed events across omitted dimensions.", "items": { "description": "Grouping label pairs that identify the slice to evaluate, passed as repeated query values. Each entry is one pair: the substring before the first comma is the label name (must not contain a comma), and the remainder of the entry (which may contain commas, or be empty) is the label value. Example: grouping_key_value=service,api&grouping_key_value=region,eu-west-1 or grouping_key_value=service, for an empty value. When omitted or empty, every permutation is considered. When provided, each label name must appear at most once and must be one of the SLO configured grouping labels; the slice includes every atomic permutation whose labels match the given pairs (a proper subset of grouping dimensions matches all permutations that agree on those labels). `lowestCompliance` and `lowestRemainingErrorBudget` are the minimum ratio across those matching permutations, not ratios recomputed from summed events across omitted dimensions.", "maxLength": 769, "minLength": 2, "pattern": "^[^,]+,.*$", "type": "string" }, "maxItems": 50, "minItems": 0, "type": "array" } }, { "description": "Inclusive lower bound of the evaluation window. When omitted, defaults to the start of the SLO configured rolling time frame ending at the effective upper bound. RFC 3339 UTC date-time on a whole-minute instant (suffix `Z`, seconds `00`, no fractional seconds).", "in": "query", "name": "from", "required": false, "schema": { "description": "Inclusive lower bound of the evaluation window. When omitted, defaults to the start of the SLO configured rolling time frame ending at the effective upper bound. RFC 3339 UTC date-time on a whole-minute instant (suffix `Z`, seconds `00`, no fractional seconds).", "format": "date-time", "maxLength": 20, "minLength": 20, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$", "type": "string", "x-coralogix-presence": true } }, { "description": "Exclusive upper bound of the evaluation window. When omitted, defaults to the current time with sub-minute precision truncated toward zero to the preceding whole UTC minute (for example 12:30:37Z becomes 12:30:00Z). When set, RFC 3339 UTC date-time on a whole-minute instant (suffix `Z`, seconds `00`, no fractional seconds).", "in": "query", "name": "to", "required": false, "schema": { "description": "Exclusive upper bound of the evaluation window. When omitted, defaults to the current time with sub-minute precision truncated toward zero to the preceding whole UTC minute (for example 12:30:37Z becomes 12:30:00Z). When set, RFC 3339 UTC date-time on a whole-minute instant (suffix `Z`, seconds `00`, no fractional seconds).", "format": "date-time", "maxLength": 20, "minLength": 20, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$", "type": "string", "x-coralogix-presence": true } }, { "description": "Optional override of the target threshold percentage for this evaluation, in the range 0-100. When omitted, the target threshold percentage configured on the SLO is used.", "in": "query", "name": "target_threshold_percentage", "required": false, "schema": { "description": "Optional override of the target threshold percentage for this evaluation, in the range 0-100. When omitted, the target threshold percentage configured on the SLO is used.", "format": "float", "maximum": 100, "minimum": 0, "type": "number", "x-coralogix-presence": true } } ], "responses": { "200": { "content": { "application/json": { "example": { "computedAt": "2026-06-30T12:30:00.000Z", "effectiveFrom": "2026-06-01T00:00:00.000Z", "effectiveTo": "2026-06-30T12:30:00.000Z", "effectiveWindowCompleteData": true, "lowestCompliance": 0.995, "lowestRemainingErrorBudget": 0.42 }, "schema": { "$ref": "#/components/schemas/GetSloStatusResponse" } } }, "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request (for example invalid grouping slice, an evaluation window wider than 28 days after applying defaults for `from` and/or `to`, or `from` and `to` that normalize to an empty window with `effectiveFrom` >= `effectiveTo`)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized request" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "SLO not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error" } }, "summary": "Get Slo Status", "tags": [ "Slos Service" ] } }, "/slo/validated/v1": { "put": { "description": "Validates and updates an SLO.", "operationId": "SlosService_ValidateReplaceSloAlerts", "requestBody": { "content": { "application/json": { "schema": { "description": "Definition of an SLO", "oneOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" }, { "not": { "anyOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" } ] }, "type": "object" } ], "properties": { "apmSli": { "$ref": "#/components/schemas/ApmSli" }, "apmSliMetadata": { "allOf": [ { "$ref": "#/components/schemas/ApmSli" } ], "description": "Server copy of apmSli for APM SLOs. Set by the server; sending it instead of apmSli is rejected.", "readOnly": true }, "createTime": { "description": "RFC3339 timestamp of when the SLO was created. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "creator": { "description": "Email or identifier of the user who created the SLO. Set by the server; a value sent by the client is ignored.", "examples": [ "test@domain.com" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of the SLO.", "examples": [ "A brief description of my SLO" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/v1.Grouping" } ], "description": "Grouping labels derived by the server from the SLI. A value sent by the client is rejected.", "readOnly": true }, "id": { "description": "Unique identifier of the SLO.", "examples": [ "b11919d5-ef85-4bb1-8655-02640dbe94d9" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "labels": { "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of labels.", "type": "object" }, "name": { "description": "Human-readable display name for the SLO. Required. A missing or empty name is rejected.", "examples": [ "Example Slo Name" ], "minLength": 1, "type": "string" }, "ownershipTags": { "allOf": [ { "$ref": "#/components/schemas/SloOwnershipTags" } ], "description": "Service, environment, and team ownership configuration for the SLO group and its permutations." }, "productType": { "allOf": [ { "$ref": "#/components/schemas/SloProductType" } ], "description": "Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs", "examples": [ "SLO_PRODUCT_TYPE_APM" ], "x-coralogix-presence": true }, "requestBasedMetricSli": { "$ref": "#/components/schemas/RequestBasedMetricSli" }, "revision": { "allOf": [ { "$ref": "#/components/schemas/v1.Revision" } ], "description": "Revision of the SLO. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "sloTimeFrame": { "allOf": [ { "$ref": "#/components/schemas/SloTimeFrame" } ], "description": "Rolling evaluation window (fixed-duration lookback)." }, "sloType": { "allOf": [ { "$ref": "#/components/schemas/SloType" } ], "description": "SLO type derived by the server from the SLI. A window-based metric SLI still reads SLO_TYPE_REQUEST. A value sent by the client must match the SLI type; a different value is rejected.", "examples": [ "SLO_TYPE_REQUEST" ], "readOnly": true, "x-coralogix-presence": true }, "targetThresholdPercentage": { "description": "Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).", "examples": [ 99.999 ], "format": "float", "type": "number" }, "type": { "deprecated": true, "description": "Deprecated: SLO type string. Set by the server from the SLI; a value sent by the client is ignored.", "examples": [ "request" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "windowBasedMetricSli": { "$ref": "#/components/schemas/WindowBasedMetricSli" } }, "required": [ "name", "sloTimeFrame" ], "title": "Slo", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceSloAlertsValidationsResponse" } } }, "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": "Replace Slo Pre-Validate Alerts", "tags": [ "Slos Service" ] } }, "/slo/zero-state/v1": { "get": { "description": "Returns the zero-state configuration for SLOs.", "operationId": "SlosService_GetZeroState", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetZeroStateResponse" } } }, "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 Slo Zero State", "tags": [ "Slos Service" ] } }, "/v3/alert-event-stats": { "get": { "description": "Returns statistical data for alert events.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertEventService_GetAlertEventsStats", "parameters": [ { "description": "The ids.", "in": "query", "name": "ids", "required": false, "schema": { "description": "The ids.", "items": { "description": "The ids.", "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string" }, "maxItems": 1000, "minItems": 0, "type": "array" } }, { "description": "The order bys.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "The order bys.", "items": { "properties": { "direction": { "$ref": "#/components/schemas/OrderByAlertEventDirection" }, "fieldName": { "$ref": "#/components/schemas/OrderByAlertEventFields" } }, "type": "object" }, "maxItems": 20, "minItems": 0, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAlertEventStatsResponse" } } }, "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 alert events statistics", "tags": [ "Alert events service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] } }, "/v3/alert-event/{id}": { "get": { "description": "Returns the alert event with the specified ID.\n\nRequires the following permissions:\n- `alerts:ReadConfig`", "operationId": "AlertEventService_GetAlertEvent", "parameters": [ { "description": "Unique identifier.", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier.", "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, { "description": "Ordering applied to the alert event occurrences in the response.", "in": "query", "name": "order_bys", "required": false, "schema": { "description": "Ordering applied to the alert event occurrences in the response.", "items": { "properties": { "direction": { "$ref": "#/components/schemas/OrderByAlertEventDirection" }, "fieldName": { "$ref": "#/components/schemas/OrderByAlertEventFields" } }, "type": "object" }, "maxItems": 20, "minItems": 0, "type": "array" } }, { "description": "Pagination parameters (page size and page token) for the returned occurrences.", "in": "query", "name": "pagination", "required": false, "schema": { "properties": { "pageSize": { "description": "Page size.", "format": "int64", "maximum": 1000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "The page token.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAlertEventResponse" } } }, "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 alert event by ID", "tags": [ "Alert events service" ], "x-coralogixPermissions": [ "alerts:ReadConfig" ] } } }, "components": { "schemas": { "ARMStack": { "title": "ARM stack", "type": "object", "properties": { "resourceGroupName": { "description": "The resource group name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "subscriptionId": { "description": "The subscription id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about the Azure Resource Manager (ARM) integration in our documentation", "url": "https://coralogix.com/docs/integrations/azure/azure-resource-manager-integration-packages/" } }, "AccessPolicyAction": { "title": "Access policy action", "type": "object", "oneOf": [ { "required": [ "upsert" ], "type": "object" }, { "required": [ "delete" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "upsert" ], "type": "object" }, { "required": [ "delete" ], "type": "object" } ] } } ], "properties": { "delete": { "allOf": [ { "$ref": "#/components/schemas/DeleteAccessPolicy" } ], "description": "Remove the alert's access policy entirely; a new policy and policy owner can be assigned afterward" }, "upsert": { "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Raw access policy JSON to set on the alert" } }, "description": "A change to the alert's access policy: upsert a raw policy, or delete (remove) the existing policy. Changing the access policy requires the alerts:UpdateAccessPolicy permission." }, "AccessType": { "title": "AccessType", "required": [ "accessType" ], "type": "object", "oneOf": [ { "required": [ "permanentAccess" ], "type": "object" }, { "required": [ "temporaryAccess" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "permanentAccess" ], "type": "object" }, { "required": [ "temporaryAccess" ], "type": "object" } ] } } ], "properties": { "accessType": { "minLength": 0, "type": "string", "description": "Type of access: 'permanent' or 'temporary'" }, "permanentAccess": { "allOf": [ { "$ref": "#/components/schemas/PermanentAccess" } ], "description": "Permanent access configuration - user has indefinite access" }, "temporaryAccess": { "allOf": [ { "$ref": "#/components/schemas/TemporaryAccess" } ], "description": "Temporary access configuration - user access expires at a specified time" } }, "description": "Defines the access duration for a user. Can be either permanent (indefinite) or temporary (expires at a specific time).", "discriminator": { "propertyName": "accessType" } }, "AcknowledgeCaseResponse": { "title": "Acknowledge case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after acknowledgment." } }, "description": "Response containing the case after it has been acknowledged." }, "AcknowledgeIncidentByEventIdResponse": { "title": "Acknowledge incident by event id response", "required": [ "incident" ], "type": "object", "properties": { "incident": { "allOf": [ { "$ref": "#/components/schemas/Incident" } ], "description": "Incident after acknowledgment" } }, "description": "Response containing the updated incident after acknowledgment" }, "AcknowledgeIncidentsResponse": { "title": "Acknowledge incidents response", "required": [ "incidents" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "List of incidents after acknowledgment" } }, "description": "Response containing the updated incidents after acknowledgment" }, "ActionDataSourceType": { "enum": [ "ACTION_DATA_SOURCE_TYPE_NONE_UNSPECIFIED", "ACTION_DATA_SOURCE_TYPE_LOGS", "ACTION_DATA_SOURCE_TYPE_SPANS", "ACTION_DATA_SOURCE_TYPE_METRICS", "ACTION_DATA_SOURCE_TYPE_DATAPRIME" ], "type": "string", "description": "Action data source type." }, "ActionDefinition": { "type": "object", "oneOf": [ { "required": [ "customAction" ], "type": "object" }, { "required": [ "goToDashboardAction" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "customAction" ], "type": "object" }, { "required": [ "goToDashboardAction" ], "type": "object" } ] } } ], "properties": { "customAction": { "allOf": [ { "$ref": "#/components/schemas/CustomAction" } ], "description": "Object defining action defined by the user" }, "goToDashboardAction": { "allOf": [ { "$ref": "#/components/schemas/GoToDashboardTemplateAction" } ], "description": "Object defining one of the pre-defined template actions - go to specific dashboard" } }, "description": "Defines the behavior of a dashboard action, either a custom URL or a built-in template." }, "ActionExecutionRequest": { "type": "object", "oneOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" } ] } } ], "properties": { "create": { "$ref": "#/components/schemas/CreateActionRequest" }, "delete": { "$ref": "#/components/schemas/DeleteActionRequest" }, "replace": { "$ref": "#/components/schemas/ReplaceActionRequest" } } }, "ActionExecutionResponse": { "type": "object", "oneOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" } ] } } ], "properties": { "create": { "$ref": "#/components/schemas/CreateActionResponse" }, "delete": { "$ref": "#/components/schemas/DeleteActionResponse" }, "replace": { "$ref": "#/components/schemas/ReplaceActionResponse" } } }, "ActivateRetentionsResponse": { "title": "Activate Retentions Response", "type": "object", "properties": { "activateRetentions": { "description": "List of retentions to activate.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "This data structure is obtained after setting 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/" } }, "ActiveSuppressionRules": { "title": "Active suppression rules", "required": [ "suppressionRuleIds" ], "type": "object", "properties": { "suppressionRuleIds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "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": "Array of active suppression rule IDs for the given alert definition." }, "description": "Array of active suppression rule IDs for the given alert definition.", "examples": [ [ "1eae3615-79e7-4b54-88e0-6a77def653bf", "2fbf4726-8af8-5c65-99f1-7b88ef764c0e" ] ] } }, "description": "Data describing the active suppression rules for an alert indicator." }, "ActiveTimeframe": { "type": "object", "properties": { "endTime": { "minLength": 0, "type": "string", "description": "End time." }, "startTime": { "minLength": 0, "type": "string", "description": "Start time." }, "timezone": { "minLength": 0, "type": "string", "description": "Timezone." } } }, "ActivityAnalysis": { "title": "Activity analysis data structure", "type": "object", "properties": { "rules": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of rules." }, "description": "List of rules." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ActivityAnalysisStatus" } ], "description": "Status." } }, "description": "Configuration for alert activity analysis, containing rules and status." }, "ActivityAnalysisStats": { "title": "Event activity analysis statistics", "type": "object", "properties": { "isMutedCount": { "description": "Number of muted items.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "rules": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of rules." }, "description": "List of rules." } }, "description": "Activity analysis stats." }, "ActivityAnalysisStatus": { "enum": [ "ACTIVITY_ANALYSIS_STATUS_ACTIVATE_OR_UNSPECIFIED", "ACTIVITY_ANALYSIS_STATUS_MUTE" ], "type": "string", "description": "Activity analysis status." }, "ActivitySchedule": { "title": "Alert activity schedule", "type": "object", "properties": { "dayOfWeek": { "maxItems": 7, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DayOfWeek" }, "description": "Day of the week.", "examples": [ [ "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED", "DAY_OF_WEEK_TUESDAY" ] ] }, "endTime": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" } ], "description": "End time of the alert activity" }, "startTime": { "allOf": [ { "$ref": "#/components/schemas/TimeOfDay" } ], "description": "Start time of the alert activity" } }, "description": "Defines when an alert should be active based on days of the week and time windows" }, "AddEnrichmentsResponse": { "title": "Encrichments Creation Response", "required": [ "enrichments" ], "type": "object", "properties": { "enrichments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "description": "List of enrichments." } }, "description": "Response data structure for enrichments creation", "externalDocs": { "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": "Exact key-value matches, combined with AND. Use advertised agent attributes such as cx.agent.type and host.name. Set custom attributes under agent_description.non_identifying_attributes of the opamp extension in the Collector configuration, or under agent.description.non_identifying_attributes in the Supervisor configuration. An empty selector matches all agents. Example: `{\"cx.agent.type\":\"docker\",\"host.name\":\"collector-host-01\"}`." } }, "description": "Exact matches against attributes advertised by the target agent. Every key-value pair must match the agent." }, "AgentSelectorResponse": { "type": "object", "properties": { "attributes": { "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Attributes of the stored selector. A remote configuration saved with an omitted or empty selector is returned without agentSelector, so the empty match-all selection is preserved; attributes are not expanded to the currently matched agents. Example: `{\"cx.agent.type\":\"docker\",\"host.name\":\"collector-host-01\",\"service.version\":\"0.160.0\"}`." } }, "description": "Agent attributes used for matching." }, "AggType": { "enum": [ "AGG_TYPE_UNSPECIFIED", "AGG_TYPE_MIN", "AGG_TYPE_MAX", "AGG_TYPE_COUNT", "AGG_TYPE_AVG", "AGG_TYPE_SUM", "AGG_TYPE_HISTOGRAM", "AGG_TYPE_SAMPLES" ], "type": "string", "description": "Agg type." }, "AiApplication": { "type": "object", "properties": { "application": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Application name." }, "companyId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Company ID" }, "createdAt": { "description": "RFC3339 timestamp when the application was first observed.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "guardrailsIntegrated": { "type": "boolean", "description": "Whether guardrails are integrated for this application." }, "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." }, "subsystem": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Subsystem name" }, "updatedAt": { "description": "RFC3339 timestamp when the application was last updated.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "AI Application" }, "AiEvaluation": { "required": [ "id" ], "type": "object", "properties": { "application": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Name of the AI application this evaluation belongs to." }, "companyId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Company that owns this evaluation." }, "config": { "allOf": [ { "$ref": "#/components/schemas/EvaluationConfig" } ], "description": "Type-specific configuration for the evaluation (oneof)." }, "createdAt": { "description": "RFC3339 timestamp when the evaluation was created.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "createdBy": { "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": "UUID of the user who created this evaluation. Set automatically by the server from the authenticated identity; not provided by the client." }, "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." }, "isEnabled": { "type": "boolean", "description": "Whether the evaluation is currently 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.", "x-coralogix-presence": true }, "threshold": { "description": "Score threshold. Must be between 0.0 and 1.0 inclusive.", "format": "double", "maximum": 1, "minimum": 0, "type": "number", "x-coralogix-presence": true }, "updatedAt": { "description": "RFC3339 timestamp when the evaluation was last updated.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "A configured AI evaluation that runs against an AI application's spans." }, "AlertDef": { "title": "Alert definition", "type": "object", "properties": { "alertDefProperties": { "allOf": [ { "$ref": "#/components/schemas/AlertDefProperties" } ], "description": "The alert definition's properties" }, "alertVersionId": { "description": "The old alert ID", "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "createdTime": { "description": "The time when the alert definition was created", "examples": [ "2023-10-01T12:00:00.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "The alert definition's persistent ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true }, "lastTriggeredTime": { "description": "The last time the alert definition was triggered", "examples": [ "2023-10-01T12:00:00.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/AlertDefStatus" } ], "description": "The current status of the alert", "examples": [ "ALERT_DEF_STATUS_OK" ], "x-coralogix-presence": true }, "updatedTime": { "description": "The time when the alert definition was last updated", "examples": [ "2023-10-01T12:00:00.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/" } }, "AlertDefAccess": { "title": "Alert definition access", "type": "object", "properties": { "accessPolicy": { "description": "The alert's raw access policy as an opaque JSON string. Present only when the caller may read it (alerts:ReadAccessPolicy granted)", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/AlertDefPermissions" } ], "description": "The caller's access decision (permission booleans) for the alert" } }, "description": "The caller's access decision for an alert together with the alert's raw access policy" }, "AlertDefCaseAutoResolveMode": { "enum": [ "ALERT_DEF_CASE_AUTO_RESOLVE_MODE_UNSPECIFIED", "ALERT_DEF_CASE_AUTO_RESOLVE_MODE_ENABLED", "ALERT_DEF_CASE_AUTO_RESOLVE_MODE_DISABLED" ], "type": "string", "description": "Case auto resolve mode." }, "AlertDefCaseDestination": { "title": "Alert definition case destination", "required": [ "connectorId", "condition" ], "type": "object", "properties": { "condition": { "maxLength": 20000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Notification Center routing condition, rendered to true or false against the case notification context to decide whether this destination is notified. Use \"true\" to notify on every case notification; otherwise filter on caseMetadata.notificationReason (for example caseActivated, caseResolved, casePriorityChanged, caseUnacknowledged). The expression syntax is documented with Notification Center routing conditions.", "examples": [ "(caseMetadata.notificationReason not in [\"caseUnacknowledged\",\"casePriorityChanged\"])" ] }, "connectorId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "ID of the Notification Center connector to notify. The connector must support the CASES entity type; list compatible connectors with GET /notifications/notification-center/v1/connectors?supported_by_entity_type=CASES.", "examples": [ "connector_id_example" ] }, "presetId": { "description": "Optional Notification Center preset ID used to render the notification. The preset must be defined for the CASES entity type and for the selected connector's type; list compatible presets with GET /notifications/notification-center/v1/presets:summariesList?entity_type=CASES&connector_type=. When omitted, the connector type's default preset is used.", "examples": [ "preset_id_example" ], "maxLength": 128, "minLength": 0, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true } }, "description": "A Notification Center connector that receives notifications about cases opened by this alert." }, "AlertDefCaseEnrichmentQuery": { "title": "Alert definition case enrichment query", "required": [ "query" ], "type": "object", "properties": { "query": { "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The enrichment query string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AlertDefCaseEnrichmentQueryType" } ], "description": "The query language of the enrichment query. Defaults to DataPrime when omitted.", "examples": [ "ALERT_DEF_CASE_ENRICHMENT_QUERY_TYPE_DATAPRIME" ] } }, "description": "A query used to enrich the case created by the alert." }, "AlertDefCaseEnrichmentQueryType": { "enum": [ "ALERT_DEF_CASE_ENRICHMENT_QUERY_TYPE_UNSPECIFIED", "ALERT_DEF_CASE_ENRICHMENT_QUERY_TYPE_DATAPRIME" ], "type": "string", "description": "Enrichment query type." }, "AlertDefCaseSettings": { "title": "Alert definition case settings", "type": "object", "properties": { "autoResolveMode": { "allOf": [ { "$ref": "#/components/schemas/AlertDefCaseAutoResolveMode" } ], "description": "Controls whether the associated case is automatically resolved when the alert resolves. Defaults to enabled when unspecified.", "examples": [ "ALERT_DEF_CASE_AUTO_RESOLVE_MODE_ENABLED" ] }, "destinations": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefCaseDestination" }, "description": "Destinations notified about the cases opened by this alert. Independent of notificationGroup.destinations: both are delivered. Replace is a full overwrite: omitting destinations removes any previously configured case destinations." }, "enrichmentQueries": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefCaseEnrichmentQuery" }, "description": "Queries used to enrich the case created by this alert" } }, "description": "Settings controlling how the alert interacts with cases." }, "AlertDefDataSource": { "type": "object", "properties": { "dataSet": { "description": "File name of the dataset", "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataSpace": { "description": "Folder name of the datasource", "maxLength": 50, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "AlertDefEnabledFilter": { "title": "AlertDef Enabled Filter", "type": "object", "properties": { "enabled": { "description": "Whether to filter for enabled (true) or disabled (false) alerts", "type": "boolean", "x-coralogix-presence": true } }, "description": "Filter by alert definition enabled status" }, "AlertDefEntityLabelsFilter": { "title": "AlertDef Entity Labels Filter", "type": "object", "properties": { "entityLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The entity label key-value pairs to filter by" }, "valuesOperator": { "allOf": [ { "$ref": "#/components/schemas/FilterValuesOperator" } ], "description": "Whether all labels must match (AND) or any label can match (OR)" } }, "description": "Filter by alert definition entity labels" }, "AlertDefIdFilter": { "title": "AlertDef ID Filter", "type": "object", "properties": { "alertId": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 100, "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 alert definition ID(s) to filter by - multiple values are OR'd together" }, "description": "The alert definition ID(s) to filter by - multiple values are OR'd together", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] }, "matchType": { "allOf": [ { "$ref": "#/components/schemas/AlertDefIdFilterMatchType" } ], "description": "Whether to include or exclude the specified alert definition IDs" } }, "description": "Filter by alert definition IDs" }, "AlertDefIdFilterMatchType": { "enum": [ "ALERT_DEF_ID_FILTER_MATCH_TYPE_UNSPECIFIED", "ALERT_DEF_ID_FILTER_MATCH_TYPE_INCLUDE", "ALERT_DEF_ID_FILTER_MATCH_TYPE_EXCLUDE" ], "type": "string" }, "AlertDefIncidentSettings": { "title": "Alert definition incident settings", "type": "object", "properties": { "minutes": { "description": "The time in minutes before the alert can be retriggered", "examples": [ 30 ], "format": "int64", "maximum": 10080, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "notifyOn": { "allOf": [ { "$ref": "#/components/schemas/NotifyOn" } ], "description": "The condition to notify about the alert", "examples": [ "NOTIFY_ON_TRIGGERED_AND_RESOLVED" ] } }, "description": "Alert def incident settings." }, "AlertDefLastTriggeredTimeFilter": { "title": "AlertDef Last Triggered Time Filter", "type": "object", "properties": { "lastTriggeredAtRange": { "$ref": "#/components/schemas/v3.TimeRange" } }, "description": "Filter by alert definition last triggered times" }, "AlertDefModifiedTimeFilter": { "title": "AlertDef Modified Time Filter", "type": "object", "properties": { "modifiedAtRange": { "$ref": "#/components/schemas/v3.TimeRange" } }, "description": "Filter by alert definition modification times" }, "AlertDefNameFilter": { "title": "AlertDef Name Filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS, CONTAINS)" }, "name": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name(s) of the alert definition - multiple values are OR'd together" }, "description": "The name(s) of the alert definition - multiple values are OR'd together" } }, "description": "Filter by alert definition names" }, "AlertDefNotificationGroup": { "title": "Alert definition notification group", "type": "object", "properties": { "destinations": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/NotificationDestination" }, "description": "The destinations for notifications. (Notification Center feature)" }, "groupByKeys": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The keys to group the alerts by" }, "description": "The keys to group the alerts by", "examples": [ [ "key1", "key2" ] ] }, "router": { "allOf": [ { "$ref": "#/components/schemas/NotificationRouter" } ], "description": "The router for notifications. (Notification Center feature)" }, "webhooks": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefWebhooksSettings" }, "description": "The settings for webhooks associated with the alert definition" } }, "description": "Alert def notification group." }, "AlertDefOrderByDirection": { "enum": [ "ALERT_DEF_ORDER_BY_DIRECTION_ASC_OR_UNSPECIFIED", "ALERT_DEF_ORDER_BY_DIRECTION_DESC" ], "type": "string", "description": "Alert def order by direction." }, "AlertDefOrderByFields": { "enum": [ "ALERT_DEF_ORDER_BY_FIELDS_UNSPECIFIED", "ALERT_DEF_ORDER_BY_FIELDS_PRIORITY", "ALERT_DEF_ORDER_BY_FIELDS_LAST_TRIGGERED_TIME", "ALERT_DEF_ORDER_BY_FIELDS_UPDATED_TIME", "ALERT_DEF_ORDER_BY_FIELDS_ENABLED" ], "type": "string", "description": "Alert def order by fields." }, "AlertDefOverride": { "title": "Alert definition priority update", "type": "object", "properties": { "priority": { "allOf": [ { "$ref": "#/components/schemas/AlertDefPriority" } ], "description": "The priority of the alert definition", "examples": [ "ALERT_DEF_PRIORITY_P3" ] } }, "description": "Alert def override." }, "AlertDefPermissions": { "title": "Alert definition permissions", "type": "object", "properties": { "canManage": { "type": "boolean", "description": "Whether the caller may edit or delete this alert — granted the update-config permission for the alert's data pillar (logs / metrics / spans / flow / SLO)" }, "canRead": { "type": "boolean", "description": "Whether the caller may view this alert — granted the read-config permission for the alert's data pillar (logs / metrics / spans / flow / SLO)" }, "canReadAccessPolicy": { "type": "boolean", "description": "Whether the caller may view this alert's access policy / permissions (alerts:ReadAccessPolicy granted)" }, "canUpdateAccessPolicy": { "type": "boolean", "description": "Whether the caller may change this alert's access policy (alerts:UpdateAccessPolicy granted)" } }, "description": "The calling user's access decision for an alert" }, "AlertDefPriority": { "enum": [ "ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED", "ALERT_DEF_PRIORITY_P4", "ALERT_DEF_PRIORITY_P3", "ALERT_DEF_PRIORITY_P2", "ALERT_DEF_PRIORITY_P1" ], "type": "string", "description": "Alert def priority." }, "AlertDefPriorityFilter": { "title": "AlertDef Priority Filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS)" }, "priority": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefPriority" }, "description": "The priority(ies) of the alert definition - multiple values are OR'd together" } }, "description": "Filter by alert definition priorities" }, "AlertDefProperties": { "title": "Alert definition properties", "type": "object", "oneOf": [ { "required": [ "logsImmediate" ], "type": "object" }, { "required": [ "tracingImmediate" ], "type": "object" }, { "required": [ "logsThreshold" ], "type": "object" }, { "required": [ "logsRatioThreshold" ], "type": "object" }, { "required": [ "logsTimeRelativeThreshold" ], "type": "object" }, { "required": [ "metricThreshold" ], "type": "object" }, { "required": [ "tracingThreshold" ], "type": "object" }, { "required": [ "flow" ], "type": "object" }, { "required": [ "logsAnomaly" ], "type": "object" }, { "required": [ "metricAnomaly" ], "type": "object" }, { "required": [ "logsNewValue" ], "type": "object" }, { "required": [ "logsUniqueCount" ], "type": "object" }, { "required": [ "sloThreshold" ], "type": "object" }, { "required": [ "analyticsImmediate" ], "type": "object" }, { "required": [ "analyticsThreshold" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logsImmediate" ], "type": "object" }, { "required": [ "tracingImmediate" ], "type": "object" }, { "required": [ "logsThreshold" ], "type": "object" }, { "required": [ "logsRatioThreshold" ], "type": "object" }, { "required": [ "logsTimeRelativeThreshold" ], "type": "object" }, { "required": [ "metricThreshold" ], "type": "object" }, { "required": [ "tracingThreshold" ], "type": "object" }, { "required": [ "flow" ], "type": "object" }, { "required": [ "logsAnomaly" ], "type": "object" }, { "required": [ "metricAnomaly" ], "type": "object" }, { "required": [ "logsNewValue" ], "type": "object" }, { "required": [ "logsUniqueCount" ], "type": "object" }, { "required": [ "sloThreshold" ], "type": "object" }, { "required": [ "analyticsImmediate" ], "type": "object" }, { "required": [ "analyticsThreshold" ], "type": "object" } ] } } ], "properties": { "activeOn": { "allOf": [ { "$ref": "#/components/schemas/ActivitySchedule" } ], "description": "The schedule defining when the alert should be active" }, "analyticsImmediate": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsImmediateType" } ], "description": "Configuration for analytics immediate alerts", "x-stability": "preview" }, "analyticsThreshold": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsThresholdType" } ], "description": "Configuration for analytics threshold alerts", "x-stability": "preview" }, "caseSettings": { "allOf": [ { "$ref": "#/components/schemas/AlertDefCaseSettings" } ], "description": "Settings controlling how the alert interacts with cases. When omitted on create, defaults apply (case auto-resolve enabled, no enrichment queries, no case destinations). Replace is a full overwrite: omitting this field on replace resets any previously configured case settings to those defaults. In read responses, this field is absent when no case settings were configured, meaning those same defaults are in effect.", "x-stability": "preview" }, "dataSources": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefDataSource" }, "description": "The sources from which to sample logs" }, "deleted": { "default": false, "description": "Whether the alert has been marked as deleted", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "description": { "description": "A detailed description of what the alert monitors and when it triggers", "examples": [ "Alert description" ], "maxLength": 3000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the alert is currently active and monitoring", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "entityLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels used to identify and categorize the alert entity" }, "flow": { "allOf": [ { "$ref": "#/components/schemas/FlowType" } ], "description": "Configuration for flow-based alerts" }, "groupByKeys": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Keys used to group and aggregate alert data" }, "description": "Keys used to group and aggregate alert data", "examples": [ [ "key1", "key2" ] ] }, "incidentsSettings": { "allOf": [ { "$ref": "#/components/schemas/AlertDefIncidentSettings" } ], "description": "Incident creation and management settings" }, "logsAnomaly": { "allOf": [ { "$ref": "#/components/schemas/LogsAnomalyType" } ], "description": "Configuration for log-based anomaly detection alerts" }, "logsImmediate": { "allOf": [ { "$ref": "#/components/schemas/LogsImmediateType" } ], "description": "Configuration for immediate log-based alerts" }, "logsNewValue": { "allOf": [ { "$ref": "#/components/schemas/LogsNewValueType" } ], "description": "Configuration for alerts triggered by new log values" }, "logsRatioThreshold": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioThresholdType" } ], "description": "Configuration for log-based ratio threshold alerts" }, "logsThreshold": { "allOf": [ { "$ref": "#/components/schemas/LogsThresholdType" } ], "description": "Configuration for log-based threshold alerts" }, "logsTimeRelativeThreshold": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeRelativeThresholdType" } ], "description": "Configuration for time-relative log threshold alerts" }, "logsUniqueCount": { "allOf": [ { "$ref": "#/components/schemas/LogsUniqueCountType" } ], "description": "Configuration for alerts based on unique log value counts" }, "metricAnomaly": { "allOf": [ { "$ref": "#/components/schemas/MetricAnomalyType" } ], "description": "Configuration for metric-based anomaly detection alerts" }, "metricThreshold": { "allOf": [ { "$ref": "#/components/schemas/MetricThresholdType" } ], "description": "Configuration for metric-based threshold alerts" }, "name": { "description": "The name of the alert definition", "examples": [ "My Alert" ], "maxLength": 512, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "notificationGroup": { "allOf": [ { "$ref": "#/components/schemas/AlertDefNotificationGroup" } ], "description": "Primary notification group for alert events" }, "notificationGroupExcess": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefNotificationGroup" }, "description": "Additional notification groups for alerts (deprecated)", "deprecated": true }, "phantomMode": { "default": false, "description": "Whether the alert is in phantom mode (creating incidents or not)", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/AlertDefPriority" } ], "description": "The priority level of the alert", "examples": [ "ALERT_DEF_PRIORITY_P4" ] }, "sloThreshold": { "allOf": [ { "$ref": "#/components/schemas/SloThresholdType" } ], "description": "Configuration for SLO-based alerts" }, "tracingImmediate": { "allOf": [ { "$ref": "#/components/schemas/TracingImmediateType" } ], "description": "Configuration for immediate tracing-based alerts" }, "tracingThreshold": { "allOf": [ { "$ref": "#/components/schemas/TracingThresholdType" } ], "description": "Configuration for tracing-based threshold alerts" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AlertDefType" } ], "description": "Alert type", "examples": [ "ALERT_DEF_TYPE_METRIC_THRESHOLD" ] } }, "description": "User-configurable properties of an alert definition" }, "AlertDefSloSpecificFilter": { "title": "AlertDef SLO Specific Filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS)" }, "sloId": { "maxItems": 100, "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 SLO ID(s) to filter by - multiple values are OR'd together" }, "description": "The SLO ID(s) to filter by - multiple values are OR'd together", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] } }, "description": "Filter SLO-based alerts by SLO-specific fields" }, "AlertDefStatus": { "enum": [ "ALERT_DEF_STATUS_UNSPECIFIED", "ALERT_DEF_STATUS_ALERTING", "ALERT_DEF_STATUS_OK", "ALERT_DEF_STATUS_NO_DATA" ], "type": "string", "description": "Alert def status." }, "AlertDefStatusFilter": { "title": "AlertDef Status Filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS)" }, "status": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefStatus" }, "description": "The status(es) of the alert definition - multiple values are OR'd together" } }, "description": "Filter by alert definition status" }, "AlertDefToCreate": { "title": "Alert definition to create", "required": [ "alertDefProperties" ], "type": "object", "properties": { "accessPolicy": { "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.", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "alertDefProperties": { "allOf": [ { "$ref": "#/components/schemas/AlertDefProperties" } ], "description": "The properties of the alert definition" } }, "description": "A single alert definition to create as part of a bulk create request" }, "AlertDefToReplace": { "title": "Alert definition to replace", "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": { "description": "The alert definition ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true } }, "description": "An alert definition along with its ID for replacement" }, "AlertDefType": { "enum": [ "ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED", "ALERT_DEF_TYPE_LOGS_THRESHOLD", "ALERT_DEF_TYPE_LOGS_ANOMALY", "ALERT_DEF_TYPE_LOGS_RATIO_THRESHOLD", "ALERT_DEF_TYPE_LOGS_NEW_VALUE", "ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT", "ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_THRESHOLD", "ALERT_DEF_TYPE_METRIC_THRESHOLD", "ALERT_DEF_TYPE_METRIC_ANOMALY", "ALERT_DEF_TYPE_TRACING_IMMEDIATE", "ALERT_DEF_TYPE_TRACING_THRESHOLD", "ALERT_DEF_TYPE_FLOW", "ALERT_DEF_TYPE_SLO_THRESHOLD", "ALERT_DEF_TYPE_ANALYTICS_IMMEDIATE", "ALERT_DEF_TYPE_ANALYTICS_THRESHOLD" ], "type": "string", "description": "Alert def type.\n- ALERT_DEF_TYPE_ANALYTICS_IMMEDIATE: preview\n- ALERT_DEF_TYPE_ANALYTICS_THRESHOLD: preview" }, "AlertDefTypeFilter": { "title": "AlertDef Type Filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS)" }, "type": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefType" }, "description": "The alert type(s) - multiple values are OR'd together" } }, "description": "Filter by alert definition types" }, "AlertDefTypeSpecificFilter": { "title": "AlertDef Type Specific Filter", "type": "object", "properties": { "sloFilter": { "allOf": [ { "$ref": "#/components/schemas/AlertDefSloSpecificFilter" } ], "description": "Filter SLO-based alerts by SLO-specific fields" } }, "description": "Filter by fields specific to alert type definitions" }, "AlertDefWebhooksSettings": { "title": "Alert definition webhook settings", "type": "object", "properties": { "integration": { "allOf": [ { "$ref": "#/components/schemas/v3.IntegrationType" } ], "description": "The integration type for webhook notifications" }, "minutes": { "description": "The time in minutes before the alert can be retriggered", "examples": [ 15 ], "format": "int64", "maximum": 10080, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "notifyOn": { "allOf": [ { "$ref": "#/components/schemas/NotifyOn" } ], "description": "The condition under which the alert should be notified", "examples": [ "NOTIFY_ON_TRIGGERED_AND_RESOLVED" ], "x-coralogix-presence": true } }, "description": "Configuration for webhook notifications for an alert" }, "AlertDefinitionMuted": { "title": "Alert definition is muted", "type": "object", "additionalProperties": false, "description": "Object indicating the muted state of the alert definition for an alert indicator." }, "AlertEvent": { "title": "Alert event", "type": "object", "properties": { "activityAnalysis": { "$ref": "#/components/schemas/ActivityAnalysis" }, "alertId": { "description": "Unique identifier of the alert.", "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "groupLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels for the group." }, "incidentCorrelationKey": { "description": "Key used to correlate incidents.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "payload": { "type": "object", "description": "Raw payload data." }, "payloadType": { "description": "Type of the payload.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutationId": { "description": "Unique identifier of the permutation.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutationLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels for the permutation." }, "preGroupingEventId": { "description": "Identifier of the event before grouping.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/AlertStatus" } ], "description": "Status." }, "timestamp": { "description": "Timestamp of the event.", "format": "date-time", "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Alert event." }, "AlertEventMultiplePermutation": { "type": "object", "properties": { "alertEventMultiplePermutation": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertEvent" }, "description": "List of alert events for multiple permutations." } }, "description": "Alert event multiple permutation." }, "AlertFilters": { "title": "Alert filters", "type": "object", "properties": { "alertIds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "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": "List of alert IDs to filter on. Cases containing any of these alert IDs will be returned (OR logic)." }, "description": "List of alert IDs to filter on. Cases containing any of these alert IDs will be returned (OR logic).", "examples": [ [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0", "a0a08c31-0ae4-4600-928e-cb6b7da50a99" ] ] }, "alertVersions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of alert version IDs to filter on. Cases containing indicators with any of these alert version IDs will be returned (OR logic)." }, "description": "List of alert version IDs to filter on. Cases containing indicators with any of these alert version IDs will be returned (OR logic).", "examples": [ [ "550e8400-e29b-41d4-a716-446655440000", "6ba7b810-9dad-11d1-80b4-00c04fd430c8" ] ] } }, "description": "Filters applied to cases based on alert properties." }, "AlertGroupingType": { "title": "Alert grouping type", "enum": [ "GROUPING_TYPE_UNSPECIFIED", "GROUPING_TYPE_COMPOSITE_ALERT", "GROUPING_TYPE_COMBINATION_ALERT", "GROUPING_TYPE_NONE" ], "type": "string", "description": "Indicates how this indicator relates to other alerts (composite, combination, or none)." }, "AlertIdAggregation": { "title": "Alert ID aggregation", "type": "object", "properties": { "alertId": { "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": "Alert definition ID", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ] }, "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases associated with this alert ID", "format": "int64", "examples": [ 5 ] } }, "description": "Count of cases associated with a single alert definition ID." }, "AlertIndicator": { "title": "Alert indicator", "required": [ "alertId", "latestAlertVersion", "priority", "groupingType", "state", "triggerTime", "alertVersions", "permutations" ], "type": "object", "properties": { "alertId": { "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": "The unique alert ID (stable across versions).", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ] }, "alertVersions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Array of all alert version IDs for this indicator in the case. Includes the latest_alert_version." }, "description": "Array of all alert version IDs for this indicator in the case. Includes the latest_alert_version.", "examples": [ [ "1eae3615-79e7-4b54-88e0-6a77def653bf", "2fbf4726-8af8-5c65-99f1-7b88ef764c0g" ] ] }, "customDataprimeQueries": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Array of custom DataPrime queries configured on the alert definition." }, "description": "Array of custom DataPrime queries configured on the alert definition.", "examples": [ [ "source logs | filter $d.severity == 'ERROR'" ] ] }, "groupingType": { "allOf": [ { "$ref": "#/components/schemas/AlertGroupingType" } ], "description": "How this indicator relates to other alerts (composite/combination/none).", "examples": [ "GROUPING_TYPE_COMPOSITE_ALERT" ] }, "latestAlertVersion": { "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Last seen version ID of the triggered alert definition.", "examples": [ "1eae3615-79e7-4b54-88e0-6a77def653bf" ] }, "permutations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertIndicator.Permutation" }, "description": "Array of the alert permutations.", "examples": [ [ { "permutation": { "service": "payments", "cluster": "prod" } }, { "permutation": { "service": "billing", "cluster": "prod" } } ] ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/IndicatorPriority" } ], "description": "Priority of the alert at trigger time.", "examples": [ "ALERT_PRIORITY_P2" ] }, "resolveTime": { "description": "When present, timestamp when the alert resolved.", "examples": [ "2025-09-22T11:05:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "resolveWithSignal": { "description": "When true or omitted, indicates that Case will be resolved together with signal. Otherwise, Case will stay open and wait for manual resolution.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/IndicatorState" } ], "description": "Current lifecycle state of the indicator.", "examples": [ "ALERT_INDICATOR_STATE_TRIGGERED" ] }, "suppression": { "allOf": [ { "$ref": "#/components/schemas/AlertSuppression" } ], "description": "When present, details about the suppression status of the alert indicator." }, "triggerTime": { "description": "Timestamp when the alert triggered.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Data describing a triggered alert instance and its lifecycle relative to a case." }, "AlertIndicator.Permutation": { "title": "Alert permutation", "type": "object", "properties": { "permutation": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "A single permutation represented as map." } }, "description": "Single alert permutation captured as a map of label keys to label values." }, "AlertIndicatorDeepLink": { "title": "Alert indicator deep link", "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "metric" ], "type": "object" }, { "required": [ "rum" ], "type": "object" }, { "required": [ "slo" ], "type": "object" }, { "required": [ "tracing" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "metric" ], "type": "object" }, { "required": [ "rum" ], "type": "object" }, { "required": [ "slo" ], "type": "object" }, { "required": [ "tracing" ], "type": "object" } ] } } ], "properties": { "alertDef": { "maxLength": 2048, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL to the alert definition that triggered the indicator. Empty when not available." }, "logs": { "$ref": "#/components/schemas/LogsLink" }, "metric": { "$ref": "#/components/schemas/MetricLink" }, "rum": { "$ref": "#/components/schemas/RumLink" }, "slo": { "$ref": "#/components/schemas/SloLink" }, "tracing": { "$ref": "#/components/schemas/TracingLink" } }, "description": "Deep links derived from a single alert indicator on a case." }, "AlertSchedulerRule": { "required": [ "name", "filter", "schedule" ], "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "type": "boolean", "description": "Whether this resource is enabled." }, "filter": { "$ref": "#/components/schemas/alert_scheduler_rule_protobuf.v1.Filter" }, "id": { "description": "Unique identifier.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "metaLabels": { "description": "Metadata labels.", "items": { "$ref": "#/components/schemas/meta_labels_protobuf.v1.MetaLabel" }, "minItems": 0, "type": "array", "x-coralogix-collection": "set" }, "name": { "minLength": 1, "type": "string", "description": "Display name." }, "schedule": { "$ref": "#/components/schemas/Schedule" }, "uniqueIdentifier": { "description": "Unique identifier.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "updatedAt": { "description": "Last-updated timestamp.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Alert scheduler rule." }, "AlertSchedulerRuleWithActiveTimeframe": { "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" }, "nextActiveTimeframes": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ActiveTimeframe" }, "description": "The next active timeframes." } } }, "AlertStatus": { "enum": [ "ALERT_STATUS_RESOLVED_OR_UNSPECIFIED", "ALERT_STATUS_TRIGGERED", "ALERT_STATUS_NO_DATA" ], "type": "string", "description": "Alert status." }, "AlertSuppression": { "title": "Alert suppression details", "type": "object", "oneOf": [ { "required": [ "activeSuppressionRules" ], "type": "object" }, { "required": [ "alertDefinitionMuted" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "activeSuppressionRules" ], "type": "object" }, { "required": [ "alertDefinitionMuted" ], "type": "object" } ] } } ], "properties": { "activeSuppressionRules": { "$ref": "#/components/schemas/ActiveSuppressionRules" }, "alertDefinitionMuted": { "$ref": "#/components/schemas/AlertDefinitionMuted" }, "suppressedTime": { "description": "Timestamp when the alert got suppressed.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Data describing the suppression status of an alert indicator, including active suppression rules and muted state." }, "AlertSuppressionStrategy": { "enum": [ "ALERT_SUPPRESSION_STRATEGY_UNSPECIFIED", "ALERT_SUPPRESSION_STRATEGY_IGNORE", "ALERT_SUPPRESSION_STRATEGY_CREATE_CASE" ], "type": "string", "description": "Alert suppression strategy." }, "AlertUniqueIds": { "type": "object", "properties": { "value": { "description": "The value.", "items": { "minLength": 0, "type": "string", "description": "The value." }, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Alert unique ids." }, "AlertsOp": { "enum": [ "ALERTS_OP_AND_OR_UNSPECIFIED", "ALERTS_OP_OR" ], "type": "string", "description": "Alerts op." }, "All": { "title": "All filter values selected", "type": "object", "additionalProperties": false, "description": "Represents selection of all items in the filter" }, "AllOption": { "required": [ "includeAll" ], "type": "object", "properties": { "includeAll": { "description": "Whether the 'All' option is offered. Must be set explicitly — send false when the option is disabled, do not omit it.", "type": "boolean", "x-coralogix-presence": true }, "label": { "description": "The label.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Synthetic 'All' option configuration. Required for static and query sources; never present for textbox sources." }, "AllValue": { "type": "object", "additionalProperties": false, "description": "All value." }, "AllowParameters": { "required": [ "rule", "keepBlockedLogs" ], "type": "object", "properties": { "keepBlockedLogs": { "description": "Whether the logs that the rule blocks are kept as low-priority logs instead of being dropped.", "type": "boolean", "x-coralogix-presence": true }, "rule": { "description": "The regular expression. Logs that do not match it are blocked. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Allow parameters. Blocks every log that does not match the regular expression." }, "AllowedLoginMode": { "enum": [ "ALLOWED_LOGIN_MODE_UNSPECIFIED", "ALLOWED_LOGIN_MODE_SSO", "ALLOWED_LOGIN_MODE_LOCAL" ], "type": "string" }, "AllowedTopicsConfig": { "required": [ "topics" ], "type": "object", "properties": { "topics": { "description": "Topics considered allowed.", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Topics considered allowed." }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the AllowedTopics evaluation." }, "Always": { "type": "object", "additionalProperties": false, "description": "Always." }, "AnalyticsImmediateType": { "title": "Analytics immediate alert type", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/DataprimeAlertQuery" } ], "description": "The DataPrime query to evaluate" }, "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 300000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "noDataPolicy": { "allOf": [ { "$ref": "#/components/schemas/NoDataPolicy" } ], "description": "Configuration for how to treat and what state to give to an alert with no data" }, "timeframeMinutes": { "description": "The evaluation window duration in minutes", "examples": [ 60 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "useRowsAsPermutations": { "description": "Whether each result row is treated as a separate permutation. Defaults to false for immediate alerts to avoid high-cardinality alerts by mistake.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Configuration for analytics alerts that fire immediately when a DataPrime query returns a result" }, "AnalyticsThresholdOperator": { "enum": [ "ANALYTICS_THRESHOLD_OPERATOR_MORE_THAN_OR_UNSPECIFIED", "ANALYTICS_THRESHOLD_OPERATOR_LESS_THAN", "ANALYTICS_THRESHOLD_OPERATOR_MORE_THAN_OR_EQUALS", "ANALYTICS_THRESHOLD_OPERATOR_LESS_THAN_OR_EQUALS", "ANALYTICS_THRESHOLD_OPERATOR_EQUALS", "ANALYTICS_THRESHOLD_OPERATOR_NOT_EQUALS" ], "type": "string", "description": "The comparison operator applied to analytics threshold rules." }, "AnalyticsThresholdRule": { "title": "Analytics threshold rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsThresholdRuleCondition" } ], "description": "The condition for the threshold rule" }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "The override settings for the alert" } }, "description": "A rule that defines a threshold condition and its priority override" }, "AnalyticsThresholdRuleCondition": { "title": "Analytics threshold rule condition", "type": "object", "properties": { "threshold": { "description": "The threshold value to compare against", "examples": [ 100 ], "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Defines the threshold value to compare against" }, "AnalyticsThresholdType": { "title": "Analytics threshold alert type", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/DataprimeAlertQuery" } ], "description": "The DataPrime query to evaluate" }, "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 300000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "noDataPolicy": { "allOf": [ { "$ref": "#/components/schemas/NoDataPolicy" } ], "description": "Configuration for how to treat and what state to give to an alert with no data" }, "operator": { "allOf": [ { "$ref": "#/components/schemas/AnalyticsThresholdOperator" } ], "description": "The comparison operator applied to all threshold rules", "examples": [ "ANALYTICS_THRESHOLD_OPERATOR_MORE_THAN_OR_UNSPECIFIED" ] }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/AnalyticsThresholdRule" }, "description": "The per-priority threshold rules" }, "targetColumn": { "description": "The name of the numeric result column to compare", "examples": [ "error_count" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeframeMinutes": { "description": "The evaluation window duration in minutes", "examples": [ 60 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "useRowsAsPermutations": { "description": "Whether each result row is treated as a separate permutation. Defaults to true for threshold alerts as permutation count is easier to estimate.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Configuration for alerts that fire when a numeric column in a DataPrime query result violates a threshold" }, "Annotation": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/AnnotationColor" }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Whether this resource is enabled.", "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "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", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "scope": { "$ref": "#/components/schemas/Annotation.WidgetScope" }, "source": { "$ref": "#/components/schemas/Annotation.Source" } } }, "Annotation.Source": { "type": "object", "oneOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "required": [ "manual" ], "type": "object" }, { "required": [ "eventRecurrence" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "required": [ "manual" ], "type": "object" }, { "required": [ "eventRecurrence" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/DataprimeSource" }, "eventRecurrence": { "$ref": "#/components/schemas/EventRecurrenceSource" }, "logs": { "$ref": "#/components/schemas/LogsSource" }, "manual": { "$ref": "#/components/schemas/ManualSource" }, "metrics": { "$ref": "#/components/schemas/MetricsSource" }, "spans": { "$ref": "#/components/schemas/SpansSource" } }, "description": "Source." }, "Annotation.WidgetScope": { "type": "object", "oneOf": [ { "required": [ "allWidgets" ], "type": "object" }, { "required": [ "specificWidgets" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "allWidgets" ], "type": "object" }, { "required": [ "specificWidgets" ], "type": "object" } ] } } ], "properties": { "allWidgets": { "$ref": "#/components/schemas/Annotation.WidgetScope.AllWidgets" }, "specificWidgets": { "$ref": "#/components/schemas/Annotation.WidgetScope.SpecificWidgets" } }, "description": "Widget scope." }, "Annotation.WidgetScope.AllWidgets": { "type": "object", "additionalProperties": false, "description": "Indicates that the annotation applies to all widgets in the dashboard." }, "Annotation.WidgetScope.SpecificWidgets": { "type": "object", "properties": { "widgetIds": { "maxItems": 1000, "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": "The widget ids." }, "description": "The widget ids." } }, "description": "Specific widgets." }, "AnnotationColor": { "enum": [ "ANNOTATION_COLOR_UNSPECIFIED", "ANNOTATION_COLOR_DEFAULT", "ANNOTATION_COLOR_GREEN", "ANNOTATION_COLOR_CYAN", "ANNOTATION_COLOR_BLUE", "ANNOTATION_COLOR_PURPLE", "ANNOTATION_COLOR_MAGENTA", "ANNOTATION_COLOR_RED", "ANNOTATION_COLOR_ORANGE", "ANNOTATION_COLOR_YELLOW" ], "type": "string", "description": "Annotation color." }, "AnnotationOrientation": { "enum": [ "ANNOTATION_ORIENTATION_VERTICAL_UNSPECIFIED", "ANNOTATION_ORIENTATION_HORIZONTAL" ], "type": "string", "description": "Annotation orientation." }, "AnomalyAlertSettings": { "title": "Anomaly alert settings", "type": "object", "properties": { "percentageOfDeviation": { "description": "The percentage of deviation from the baseline for triggering the alert.", "format": "float", "minimum": 0, "type": "number", "x-coralogix-presence": true } }, "description": "Common settings for anomaly-based alerts." }, "ApiKeyActor": { "title": "API key actor", "type": "object", "properties": { "id": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "API key ID", "examples": [ "2b1c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e" ] }, "name": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "API key name", "examples": [ "Incident Management Integration Key" ] } }, "description": "Information about the API key that initiated the action." }, "ApiKeyData": { "title": "API key data", "type": "object", "properties": { "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Api key data." }, "ApiKeyOwner": { "title": "API Key Owner", "type": "object", "properties": { "user": { "$ref": "#/components/schemas/ApiKeyUserOwner" } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "ApiKeyStatusUpdate": { "title": "API Key Status Update", "type": "object", "properties": { "active": { "type": "boolean", "description": "Whether this resource is active.", "examples": [ true ] }, "keyId": { "minLength": 0, "type": "string", "description": "Key identifier.", "examples": [ "key_abc123" ] } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "ApiKeySummary": { "title": "API Key Summary", "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/v3.ApiKey" }, "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions.", "examples": [ "logs:read" ] }, "description": "List of permissions." }, "presets": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PermissionsPreset" }, "description": "List of permission presets." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "ApiKeyUserOwner": { "title": "API Key User Owner", "type": "object", "properties": { "userEmail": { "minLength": 0, "type": "string", "description": "The user email.", "examples": [ "test@example.com" ] }, "userId": { "minLength": 0, "type": "string", "description": "The user id.", "examples": [ "user_123" ] } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "ApmDatabaseEntity": { "title": "APM database entity", "type": "object", "properties": { "name": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the impacted database", "examples": [ "orders-db" ] }, "system": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Database system (e.g., postgresql, mysql)", "examples": [ "postgresql" ] } }, "description": "Application Performance Monitoring database identified as impacted by a case." }, "ApmDatabaseEntityFilter": { "title": "APM database entity filter", "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the impacted database to filter on", "examples": [ "orders-db" ] } }, "description": "Selects cases impacting the APM database with this name (matched case-insensitively)." }, "ApmErrorSli": { "title": "ApmErrorSli", "type": "object", "additionalProperties": false, "description": "Configuration for error-based APM SLI" }, "ApmFilter": { "title": "ApmFilter", "required": [ "key" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Label/tag name to filter on. Required. A missing or empty key is rejected.", "examples": [ "environment" ] }, "matchOperator": { "allOf": [ { "$ref": "#/components/schemas/ApmFilterMatchOperator" } ], "description": "How literals on `key` are compared. Every item in `apmSli.filters` must use the same mode: all implicit (legacy) or all explicit — mixing modes in one list is rejected. Implicit: omitted or `APM_FILTER_MATCH_OPERATOR_UNSPECIFIED` on every item — multiple items with the same `key` OR-merge literals with exact (IS) comparison; sending `UNSPECIFIED` is equivalent to omitting the field (neither is stored as explicit `IS`). Explicit: `APM_FILTER_MATCH_OPERATOR_IS`, `STARTS_WITH`, `ENDS_WITH`, or `INCLUDES` on every item — each item is a separate AND criterion; OR applies only among literals in that item (explicit `IS` differs from implicit when several items share a `key`). Items on different keys are AND-combined. Pattern operators use literal substring matching (not caller-supplied regex). Applies only when the item has at least one literal: non-empty `values`, or deprecated `value` when `values` is omitted or empty (non-empty `values` takes precedence over `value`); otherwise rejected." }, "value": { "minLength": 0, "type": "string", "description": "Deprecated: use values instead. Single value to match (kept for backward compatibility)", "examples": [ "production" ], "deprecated": true }, "values": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Preferred: multiple values to match (OR semantics, e.g. status IN [500, 503])", "examples": [ "500" ] }, "description": "Preferred: multiple values to match (OR semantics, e.g. status IN [500, 503])" } }, "description": "Key-value filter for APM metrics. Supports single value (legacy) or multiple values (OR semantics)" }, "ApmFilterMatchOperator": { "enum": [ "APM_FILTER_MATCH_OPERATOR_UNSPECIFIED", "APM_FILTER_MATCH_OPERATOR_IS", "APM_FILTER_MATCH_OPERATOR_STARTS_WITH", "APM_FILTER_MATCH_OPERATOR_ENDS_WITH", "APM_FILTER_MATCH_OPERATOR_INCLUDES" ], "type": "string", "description": "How each entry in the filter's `values` list is compared to the metric label named in `key`. Case-sensitive. IS: exact equality. STARTS_WITH: prefix. ENDS_WITH: suffix. INCLUDES: contains the value. Entries in `values` are literal strings (not caller regex); metacharacters are escaped in the PromQL label matcher. Multiple values are OR." }, "ApmLatencyAverage": { "title": "ApmLatencyAverage", "type": "object", "additionalProperties": false, "description": "Average/mean-based latency measurement" }, "ApmLatencyQuantile": { "title": "ApmLatencyQuantile", "type": "object", "properties": { "percentile": { "type": "number", "description": "Percentile for latency SLOs (0.95 = P95, 0.99 = P99)", "format": "float", "examples": [ 0.95 ] } }, "description": "Quantile/percentile-based latency measurement" }, "ApmLatencySli": { "title": "ApmLatencySli", "required": [ "timeWindow" ], "type": "object", "oneOf": [ { "required": [ "quantile" ], "type": "object" }, { "required": [ "average" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "quantile" ], "type": "object" }, { "required": [ "average" ], "type": "object" } ] } } ], "properties": { "average": { "$ref": "#/components/schemas/ApmLatencyAverage" }, "quantile": { "$ref": "#/components/schemas/ApmLatencyQuantile" }, "threshold": { "type": "number", "description": "Threshold in milliseconds. Good when latency <= threshold, bad when latency > threshold.", "format": "float", "examples": [ 500 ] }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/WindowSloWindow" } ], "description": "Time window for latency calculations. Required. Omitting it is rejected.", "examples": [ "WINDOW_SLO_WINDOW_5_MINUTES" ] } }, "description": "Configuration for latency-based APM SLI" }, "ApmServiceEntity": { "title": "APM service entity", "type": "object", "properties": { "language": { "description": "Programming language of the APM service", "examples": [ "go" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the impacted APM service", "examples": [ "payments-api" ] } }, "description": "Application Performance Monitoring service identified as impacted by a case." }, "ApmServiceEntityFilter": { "title": "APM service entity filter", "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the impacted APM service to filter on", "examples": [ "payments-api" ] } }, "description": "Selects cases impacting the APM service with this name (matched case-insensitively)." }, "ApmSli": { "title": "ApmSli", "required": [ "services" ], "type": "object", "oneOf": [ { "required": [ "errorConfig" ], "type": "object" }, { "required": [ "latencyConfig" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "errorConfig" ], "type": "object" }, { "required": [ "latencyConfig" ], "type": "object" } ] } } ], "properties": { "errorConfig": { "$ref": "#/components/schemas/ApmErrorSli" }, "filters": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ApmFilter" }, "description": "Additional label-based filters to apply to the metrics" }, "groupingKeys": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Labels to group SLO results by" }, "description": "Labels to group SLO results by", "examples": [ [ "environment", "region" ] ] }, "latencyConfig": { "$ref": "#/components/schemas/ApmLatencySli" }, "services": { "minItems": 1, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of service names to monitor. Required. At least one service; an empty list is rejected." }, "description": "List of service names to monitor. Required. At least one service; an empty list is rejected.", "examples": [ [ "ws-service-catalog" ] ] } }, "description": "Definition of an APM-based SLI with automatic query generation" }, "ApplicationNameConstraint": { "type": "object", "properties": { "value": { "description": "The value.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Application name constraint." }, "ArcDisplay": { "title": "ArcDisplay", "type": "object", "properties": { "thresholdArc": { "description": "Whether to show the threshold arc which graphically represents the threshold bands over the min/max range (replaces the deprecated showOuterArc)", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "valueArc": { "description": "Whether to show the value arc which graphically represents the current value (replaces the deprecated showInnerArc)", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Arc display settings; the presence of this object indicates the gauge arcs are shown while its absence hides all arcs, and the fields control which individual arcs are displayed" }, "ArchiveConfigurationGroupResponse": { "type": "object", "additionalProperties": false, "description": "Empty response returned after archiving a fleet-manager configuration group." }, "ArchiveConfigurationOverlayResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Archived configuration overlay UUID v7." } }, "description": "Response containing the archived configuration overlay ID." }, "ArchiveRetention": { "type": "object", "properties": { "id": { "description": "Unique identifier.", "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", "x-coralogix-presence": true } }, "description": "Archive retention." }, "ArchiveSpec": { "title": "Archive Spec", "type": "object", "properties": { "archivingFormatId": { "minLength": 0, "type": "string", "description": "The archiving format ID.", "examples": [ "json_id" ], "deprecated": true }, "enableTags": { "type": "boolean", "description": "The enable tags.", "examples": [ true ] }, "format": { "$ref": "#/components/schemas/TargetFormat" }, "isActive": { "type": "boolean", "description": "Whether archiving to this target is active.", "examples": [ true ] } }, "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "AssignCaseResponse": { "title": "Assign case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after assigning a user to it." } }, "description": "Response containing the case after a user assignment." }, "AssignDashboardFolderResponse": { "title": "Assign dashboard to folder response data structure", "type": "object", "additionalProperties": false, "description": "This is a response confirming that folder has been successfully assigned to a dashboard", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "AssignIncidentsResponse": { "title": "Assign incidents response", "required": [ "incidents" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "List of incidents after assignment" } }, "description": "Response containing the updated incidents after assignment" }, "AssignedCaseEvent": { "title": "Assigned event", "type": "object", "properties": { "assigneeUserId": { "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": "New assignee user ID", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ] }, "previousAssigneeUserId": { "description": "Previous assignee user ID (if any)", "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", "x-coralogix-presence": true } }, "description": "Assigned case event." }, "AssigneeAggregation": { "title": "Assignee aggregation", "required": [ "assignedCounts" ], "type": "object", "properties": { "assignedCounts": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AssigneeCount" }, "description": "Counts of cases grouped by assignee" }, "unassignedCount": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases without an assignee", "format": "int64" } }, "description": "Case counts broken down by assignee plus the count of unassigned cases." }, "AssigneeCount": { "title": "Assignee count", "type": "object", "properties": { "assignee": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Identifier of the assignee" }, "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases assigned to this assignee", "format": "int64" } }, "description": "Count of cases for a single assignee." }, "AssigneeOption": { "title": "Assignee option", "type": "object", "oneOf": [ { "required": [ "assignee" ], "type": "object" }, { "required": [ "unassigned" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "assignee" ], "type": "object" }, { "required": [ "unassigned" ], "type": "object" } ] } } ], "properties": { "assignee": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "User identifier of the assignee to filter by", "examples": [ "e07db42e-eb1c-4c14-ab68-e4d245ae63a5" ] }, "unassigned": { "allOf": [ { "$ref": "#/components/schemas/Unassigned" } ], "description": "Selects cases that have no assignee" } }, "description": "Assignee filter option representing either a specific assignee or unassigned cases." }, "AssigneeWithCount": { "title": "Assignee with count", "required": [ "assignee", "count" ], "type": "object", "properties": { "assignee": { "description": "Assignee.", "examples": [ "assignee" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } }, "Assignment": { "title": "Assignment", "required": [ "assignedTo", "assignedBy" ], "type": "object", "properties": { "assignedBy": { "$ref": "#/components/schemas/incidents.v1.UserDetails" }, "assignedTo": { "$ref": "#/components/schemas/incidents.v1.UserDetails" } }, "description": "Details of the user who assigned the incident and the user to whom it was assigned" }, "AtomicBatchExecuteActionsResponse": { "type": "object", "properties": { "matchingResponses": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ActionExecutionResponse" }, "description": "The matching responses." } } }, "AtomicBatchExecuteE2MResponse": { "type": "object", "properties": { "matchingResponses": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/E2MExecutionResponse" }, "description": "The matching responses." } }, "description": "Response returned after atomically executing a batch of events-to-metrics rules." }, "AtomicOverwriteAllEnrichmentsResponse": { "type": "object", "properties": { "enrichments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "description": "List of enrichments." } }, "description": "Response returned after atomically replacing all enrichment rules." }, "AtomicOverwriteEnrichmentsResponse": { "type": "object", "properties": { "enrichments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "description": "List of enrichments." } }, "description": "Response returned after atomically updating enrichment rules." }, "AtomicOverwriteLogPoliciesResponse": { "title": "Atomic Overwrite Log Policies Response", "type": "object", "properties": { "createResponses": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CreatePolicyResponse" }, "description": "The create responses." } }, "description": "This data structue is obtained when overwriting log policies atomically.", "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", "properties": { "createResponses": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CreatePolicyResponse" }, "description": "The create responses." } }, "description": "This data structure is obtained when overwriting RUM policies atomically.", "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", "properties": { "createResponses": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CreatePolicyResponse" }, "description": "The create responses." } }, "description": "This data structue is obtained when overwriting span policies atomically.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "Attachment": { "title": "Slack attachment configuration", "required": [ "type" ], "type": "object", "properties": { "isActive": { "description": "Whether this attachment is active. An omitted or false value is absent from Get responses.", "type": "boolean", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AttachmentType" } ], "examples": [ "1" ] } } }, "AttachmentConfig": { "type": "object", "properties": { "policy": { "allOf": [ { "$ref": "#/components/schemas/AttachmentConfigPolicy" } ], "description": "Default policy applied to all attachment types.", "examples": [ "AUTO" ] } }, "description": "Attachment config." }, "AttachmentConfigPolicy": { "enum": [ "AUTO", "ENABLED", "DISABLED" ], "type": "string", "description": "Attachment config policy." }, "AttachmentType": { "enum": [ "EMPTY", "METRIC_SNAPSHOT", "LOGS" ], "type": "string", "description": "Attachment type." }, "AutoCloseConfig": { "title": "Auto Close config", "required": [ "postResolutionPeriod" ], "type": "object", "properties": { "postResolutionPeriod": { "description": "Period after which resolved cases are automatically closed.", "examples": [ "3600s" ], "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Configuration for automatically closing cases after a certain period past resolution." }, "AutoIntervalResolution": { "title": "AutoIntervalResolution", "type": "object", "properties": { "maximumDataPoints": { "description": "Maximum number of data points to display. The calculated interval ensures this limit is not exceeded.", "examples": [ 500 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "minimumInterval": { "description": "Minimum interval duration. The calculated interval will not be smaller than this value.", "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Automatic interval resolution that calculates optimal time buckets based on the widget width, time range, and specified constraints." }, "AutoRefreshFifteenMinutes": { "type": "object", "additionalProperties": false, "description": "Auto refresh fifteen minutes." }, "AutoRefreshFiveMinutes": { "type": "object", "additionalProperties": false, "description": "Auto refresh five minutes." }, "AutoRefreshOff": { "type": "object", "additionalProperties": false, "description": "Auto refresh off." }, "AutoRefreshOneMinute": { "type": "object", "additionalProperties": false, "description": "Auto refresh one minute." }, "AutoRefreshTwoMinutes": { "type": "object", "additionalProperties": false, "description": "Auto refresh two minutes." }, "AutoResolveConfig": { "title": "Auto resolve config", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/disable automatic resolution" }, "inactivePeriod": { "description": "Period of inactivity after which cases are automatically resolved.", "examples": [ "3600s" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Configuration for automatically resolving cases after a certain period of inactivity." }, "Average": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Average." }, "AwsEventBridgeConfig": { "title": "AWS EventBridge configuration", "required": [ "eventBusArn", "detail", "detailType", "source", "roleName" ], "type": "object", "properties": { "detail": { "description": "Detail.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "detailType": { "description": "The detail type.", "examples": [ "detail_type" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "eventBusArn": { "description": "The event bus arn.", "examples": [ "arn:aws:events:us-east-1:123456789012:event-bus/default" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "roleName": { "description": "The role name.", "examples": [ "role_name" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "source": { "description": "Source.", "examples": [ "source" ], "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Aws event bridge config." }, "AwsType": { "type": "object", "properties": { "resourceType": { "description": "The resource type. Must be one of the AWS resource types available for the account.", "examples": [ "aws:ec2:instance" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Aws type." }, "AzureArm": { "title": "Azure ARM", "type": "object", "additionalProperties": false }, "AzureArmTemplate": { "title": "Azure ARM template", "type": "object", "properties": { "templateUrl": { "description": "The template url.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "BarChart": { "title": "BarChart", "type": "object", "properties": { "barValueDisplay": { "allOf": [ { "$ref": "#/components/schemas/widgets.BarValueDisplay" } ], "description": "Specifies where to display the bar value" }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "examples": [ "classic" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "examples": [ "mph" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a bar group, can contain variables", "examples": [ "Result - {{ variable }}" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/BarChart.Query" } ], "description": "Query object" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortBy": { "allOf": [ { "$ref": "#/components/schemas/SortByType" } ], "description": "Sort type, by name or by value", "examples": [ "1" ] }, "stackDefinition": { "allOf": [ { "$ref": "#/components/schemas/BarChart.StackDefinition" } ], "description": "Configuration of stacked bars" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "xAxis": { "allOf": [ { "$ref": "#/components/schemas/XAxis" } ], "description": "Specifies how to organize the x axis of the chart" }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis (only applicable when X axis is time-based)", "x-coralogix-presence": true }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "BarChart represents the configuration of a vertical bar chart widget." }, "BarChart.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which results are grouped" }, "description": "List of field names by which results are grouped" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "BarChart.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names to group the query results" }, "description": "List of field names to group the query results" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields to group the results" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "stackedGroupName": { "description": "Field name by which results are stacked in individual group", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Observation field by results are stacked in a group" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "A logs variant of the query" }, "BarChart.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/common.Aggregation" } ], "description": "Aggregation function" }, "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder mode", "examples": [ "1" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which metric results are grouped" }, "description": "List of field names by which metric results are grouped" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "BarChart.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/BarChart.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/BarChart.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/BarChart.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/BarChart.SpansQuery" } }, "description": "Query." }, "BarChart.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Span query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields definitions to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search span records" }, "stackedGroupName": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "Field name by which results are stacked in individual group" }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/SpanObservationField" } ], "description": "Observation field definition by which groups are divided into subgroups" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "BarChart.StackDefinition": { "type": "object", "properties": { "maxSlicesPerBar": { "description": "How many slices can fit in a single bar", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "stackNameTemplate": { "description": "Custom template name of an individual stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Bar chart.stack definition." }, "BatchExecuteSloResponse": { "title": "BatchExecuteSloResponse", "required": [ "matchingResponses" ], "type": "object", "properties": { "matchingResponses": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SloExecutionResponse" }, "description": "The matching responses." }, "status": { "$ref": "#/components/schemas/ResponseStatus" } }, "description": "Response containing the results of batch executed SLO operations." }, "BatchGetConnectorSummariesResponse": { "title": "Batch Get Connector Summaries Response", "type": "object", "properties": { "connectorSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ConnectorSummary" }, "description": "The connector summaries." }, "notFoundIds": { "maxItems": 800, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids.", "examples": [ [ "connector-id-3" ] ] } }, "description": "Response containing the requested connector summaries and any IDs not found", "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", "properties": { "connectors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Connector" }, "description": "The connectors." }, "notFoundIds": { "maxItems": 800, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids.", "examples": [ [ "connector-id-3" ] ] } }, "description": "Response containing the requested connectors and any IDs not found", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "BatchGetEventResponse": { "type": "object", "properties": { "events": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CxEventSingleOrMultiple" }, "description": "List of events." }, "notFoundIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids." }, "pagination": { "$ref": "#/components/schemas/events.v3.PaginationResponse" } }, "description": "Response containing the details of an alert event." }, "BatchGetGlobalRoutersResponse": { "title": "Batch Get Global Routers Response", "type": "object", "properties": { "notFoundIds": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids.", "examples": [ [ "global-router-id-3" ] ] }, "routers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GlobalRouter" }, "description": "The routers." } }, "description": "Response containing requested global routers and missing global routers ids", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "BatchGetIncidentResponse": { "title": "Batch get incidents response", "required": [ "incidents", "notFoundIds" ], "type": "object", "properties": { "incidents": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Incident" }, "description": "Map of incident IDs to their corresponding incidents" }, "notFoundIds": { "maxItems": 10000, "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": "List of IDs that were not found" }, "description": "List of IDs that were not found", "examples": [ [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301", "9c858901-8a57-4791-81fe-4c455b099bc9" ] ] } }, "description": "Response containing the requested incidents and any IDs that weren't found" }, "BatchGetPresetsResponse": { "title": "Batch Get Presets Response", "type": "object", "properties": { "notFoundIds": { "maxItems": 600, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids." }, "presets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Preset" }, "description": "List of permission presets." } }, "description": "Response containing the requested presets and any IDs not found", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "BatchGetSlosResponse": { "title": "BatchGetSlosResponse", "required": [ "slos" ], "type": "object", "properties": { "notFoundIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The not found ids." }, "description": "The not found ids." }, "slos": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Slo" }, "description": "The slos." } }, "description": "Response containing a batch of SLOs and any IDs not found." }, "BlockParameters": { "required": [ "rule", "keepBlockedLogs" ], "type": "object", "properties": { "keepBlockedLogs": { "description": "Whether the logs that the rule blocks are kept as low-priority logs instead of being dropped.", "type": "boolean", "x-coralogix-presence": true }, "rule": { "description": "The regular expression. Logs that match it are blocked. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Block parameters. Blocks every log that matches the regular expression." }, "BreachStatus": { "title": "Breach status", "enum": [ "BREACH_STATUS_UNSPECIFIED", "BREACH_STATUS_BREACHED", "BREACH_STATUS_MITIGATED" ], "type": "string", "description": "Status of a KPI breach (e.g., still breached or mitigated)." }, "BreachedKPI": { "title": "Breached KPI", "required": [ "id", "createdAt", "kpiType", "casePriority", "breachedAt", "breachStatus" ], "type": "object", "properties": { "breachStatus": { "allOf": [ { "$ref": "#/components/schemas/BreachStatus" } ], "description": "Current status of the KPI breach", "examples": [ "BREACH_STATUS_BREACHED" ] }, "breachedAt": { "description": "When the KPI breach occurred", "examples": [ "2025-09-22T11:00:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "casePriority": { "allOf": [ { "$ref": "#/components/schemas/KPIPriority" } ], "description": "KPI (Case) priority at the time of KPI breach", "examples": [ "KPI_PRIORITY_P1" ] }, "createdAt": { "description": "When the breached KPI record was created", "examples": [ "2025-09-22T11:00:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "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 the breached KPI", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ] }, "kpiType": { "allOf": [ { "$ref": "#/components/schemas/KPIType" } ], "description": "Type of the breached KPI", "examples": [ "KPI_TYPE_TIME_TO_ACKNOWLEDGE" ] } }, "description": "Breached KPI details, including the type of KPI, the case priority at the time of breach, and when the breach occurred together with current status. This information helps understand which KPIs were not met for a case and when." }, "Bucket": { "type": "object", "properties": { "entries": { "maxItems": 100000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageEntry" }, "description": "Usage entries inside this bucket, one per unique combination of `groupBy` values." }, "range": { "allOf": [ { "$ref": "#/components/schemas/UsageTimestampRange" } ], "description": "Half-open timestamp range for this bucket." } }, "description": "A single time bucket of grouped usage entries." }, "BulkAcknowledgeResponse": { "title": "Bulk acknowledge response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkAssignResponse": { "title": "Bulk assign response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkClearPriorityOverrideResponse": { "title": "Bulk clear priority override response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkCloseResponse": { "title": "Bulk close response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkCreateAlertDefsResponse": { "title": "Bulk create alert definitions response", "type": "object", "properties": { "alertDefs": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDef" }, "description": "List of successfully created alert definitions, returned in the order of their corresponding request entries. Request entries that failed to be created are omitted here and reported by index in failedToCreateAlertDefs." }, "failedToCreateAlertDefs": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FailedToCreateAlertDef" }, "description": "List of request entries that failed to be created, each identified by its zero-based index in the request list" } }, "description": "A response that contains the results of the bulk create operation" }, "BulkDeleteAlertDefsResponse": { "title": "Bulk delete alert definitions response", "type": "object", "properties": { "deletedIds": { "maxItems": 100, "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": "IDs of alert definitions that were successfully deleted" }, "description": "IDs of alert definitions that were successfully deleted", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] }, "notFoundIds": { "maxItems": 100, "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": "IDs of alert definitions that were not found" }, "description": "IDs of alert definitions that were not found", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] } }, "description": "A response to the bulk deletion of alert definitions. The operation is atomic - either all alerts are deleted or none are." }, "BulkDeleteRuleGroupResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after deleting all parsing rule groups." }, "BulkReplaceAlertDefsResponse": { "title": "Bulk replace alert definitions response", "type": "object", "properties": { "alertDefs": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDef" }, "description": "List of successfully replaced alert definitions" }, "failedToReplaceAlertDefs": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FailedToReplaceAlertDef" }, "description": "List of alert definitions that failed to be replaced" }, "notFoundIds": { "maxItems": 100, "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": "List of alert definition IDs that were not found" }, "description": "List of alert definition IDs that were not found", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] }, "skippedIds": { "maxItems": 100, "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": "List of alert definition IDs that were skipped (no changes detected)" }, "description": "List of alert definition IDs that were skipped (no changes detected)", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] } }, "description": "A response that contains the results of the bulk replace operation" }, "BulkResolveResponse": { "title": "Bulk resolve response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkSetPriorityOverrideResponse": { "title": "Bulk override priority response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BulkTestLogPoliciesResponse": { "title": "Bulk Test Log Policies Response", "required": [ "testPoliciesBulkResult" ], "type": "object", "properties": { "testPoliciesBulkResult": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TestPoliciesResult" }, "description": "The test policies bulk result." } }, "description": "Response 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/" } }, "BulkUnassignResponse": { "title": "Bulk unassign response", "required": [ "cases" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Updated cases" } }, "description": "Response containing the updated cases" }, "BurnRateThreshold": { "title": "Burn Rate Threshold", "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": { "allOf": [ { "$ref": "#/components/schemas/BurnRateTypeDual" } ], "description": "Burn rate type dual" }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SloThresholdRule" }, "description": "The rules for the burn rate threshold" }, "single": { "allOf": [ { "$ref": "#/components/schemas/BurnRateTypeSingle" } ], "description": "Burn rate type single" } }, "description": "Burn rate threshold definition" }, "BurnRateTypeDual": { "title": "Burn Rate Type Dual", "type": "object", "properties": { "timeDuration": { "$ref": "#/components/schemas/TimeDuration" } }, "description": "Burn rate type dual definition" }, "BurnRateTypeSingle": { "title": "Burn Rate Type Single", "type": "object", "properties": { "timeDuration": { "$ref": "#/components/schemas/TimeDuration" } }, "description": "Burn rate type single definition" }, "Case": { "title": "Case", "required": [ "id", "title", "status", "priority", "category", "createTime", "labels", "groupings", "impactedEntities" ], "type": "object", "properties": { "acknowledgeTime": { "description": "When the case was acknowledged", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "aiSummary": { "description": "AI summary of the case. Leading and trailing whitespace is trimmed before the length limits are applied.", "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "assignee": { "allOf": [ { "$ref": "#/components/schemas/cases.v1.UserDetails" } ], "description": "Assigned user details" }, "caseIndicators": { "allOf": [ { "$ref": "#/components/schemas/CaseIndicators" } ], "description": "Grouped case indicators" }, "category": { "allOf": [ { "$ref": "#/components/schemas/CaseCategory" } ], "description": "Category of the case", "examples": [ "CASE_CATEGORY_AVAILABILITY" ] }, "createTime": { "description": "When the case was created", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "duration": { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Measures how long the Case is/was opened in milliseconds" }, "groupings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.KeyValue" }, "description": "Grouping dimensions (e.g., service, subsystem)" }, "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 of the case", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ] }, "impactedEntities": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ImpactedEntity" }, "description": "Impacted entities (e.g., service, database)" }, "kpiBreaches": { "allOf": [ { "$ref": "#/components/schemas/KPIBreaches" } ], "description": "KPI breaches" }, "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.KeyValue" }, "description": "User-defined labels for the case", "examples": [ [ { "key": "team", "value": "backend" } ] ] }, "ollyAnalysis": { "allOf": [ { "$ref": "#/components/schemas/OllyAnalysis" } ], "description": "Automated Olly analysis attached to the case." }, "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Priority of the case", "examples": [ "CASE_PRIORITY_P2" ] }, "priorityDetails": { "allOf": [ { "$ref": "#/components/schemas/PriorityDetails" } ], "description": "System and override priority details" }, "readableId": { "description": "Readable identifier of the case, available only for the cases that became Active. May be used interchangeably with `id` when calling Cases APIs that target a specific case.", "examples": [ "CASE-123" ], "maxLength": 64, "minLength": 1, "pattern": "^[A-Z]+-[0-9]+$", "type": "string", "x-coralogix-presence": true }, "resolutionDetails": { "allOf": [ { "$ref": "#/components/schemas/ResolutionDetails" } ], "description": "Resolution metadata" }, "status": { "allOf": [ { "$ref": "#/components/schemas/CaseStatus" } ], "description": "Current status of the case", "examples": [ "CASE_STATUS_ACKNOWLEDGED" ] }, "title": { "maxLength": 512, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Case title. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "Database outage investigation" ] }, "updateTime": { "description": "When the case was last updated", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Represents a case within the Cases service." }, "CaseCategory": { "title": "Case category", "enum": [ "CASE_CATEGORY_UNSPECIFIED", "CASE_CATEGORY_SECURITY", "CASE_CATEGORY_AVAILABILITY" ], "type": "string", "description": "Broad category of the case (e.g., security, availability)." }, "CaseDeepLinks": { "title": "Case deep links", "type": "object", "properties": { "alertIndicators": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlertIndicatorDeepLink" }, "description": "Per-alert-indicator deep links, keyed by alert_indicator_id." }, "detail": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Absolute URL to the case detail page." }, "impactedEntities": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ImpactedEntityLink" }, "description": "Per-impacted-entity drilldown links." } }, "description": "Pre-built URLs that navigate from a case to the relevant views." }, "CaseEvent": { "title": "Case event", "required": [ "eventId", "eventData", "actor", "createTime", "eventTime" ], "type": "object", "properties": { "actor": { "allOf": [ { "$ref": "#/components/schemas/EventActor" } ], "description": "Actor that produced the event (system or user)" }, "createTime": { "description": "Server-side insertion time", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "eventData": { "allOf": [ { "$ref": "#/components/schemas/CaseEventData" } ], "description": "Event payload (assignment, comment, status change, etc.)" }, "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": "Unique identifier of the event", "examples": [ "ef51d3d9-a301-496b-aa7d-9a6e519ba0d5" ] }, "eventTime": { "description": "Logical occurrence time of the event", "examples": [ "2025-09-22T10:29:45.000Z" ], "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "If edited, last modification time of the event", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Represents an immutable entry in a case's event timeline." }, "CaseEventData": { "title": "Case event data", "type": "object", "oneOf": [ { "required": [ "assigned" ], "type": "object" }, { "required": [ "unassigned" ], "type": "object" }, { "required": [ "comment" ], "type": "object" }, { "required": [ "statusChanged" ], "type": "object" }, { "required": [ "notificationSent" ], "type": "object" }, { "required": [ "notificationFailed" ], "type": "object" }, { "required": [ "created" ], "type": "object" }, { "required": [ "priorityDetailsChanged" ], "type": "object" }, { "required": [ "titleChangedEvent" ], "type": "object" }, { "required": [ "resolutionReasonChangedEvent" ], "type": "object" }, { "required": [ "changeAssigneeFailed" ], "type": "object" }, { "required": [ "kpiBreached" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "assigned" ], "type": "object" }, { "required": [ "unassigned" ], "type": "object" }, { "required": [ "comment" ], "type": "object" }, { "required": [ "statusChanged" ], "type": "object" }, { "required": [ "notificationSent" ], "type": "object" }, { "required": [ "notificationFailed" ], "type": "object" }, { "required": [ "created" ], "type": "object" }, { "required": [ "priorityDetailsChanged" ], "type": "object" }, { "required": [ "titleChangedEvent" ], "type": "object" }, { "required": [ "resolutionReasonChangedEvent" ], "type": "object" }, { "required": [ "changeAssigneeFailed" ], "type": "object" }, { "required": [ "kpiBreached" ], "type": "object" } ] } } ], "properties": { "assigned": { "allOf": [ { "$ref": "#/components/schemas/AssignedCaseEvent" } ], "description": "Case assigned to a user" }, "changeAssigneeFailed": { "allOf": [ { "$ref": "#/components/schemas/ChangeAssigneeFailedEvent" } ], "description": "Change assignee failed case event" }, "comment": { "allOf": [ { "$ref": "#/components/schemas/CommentCaseEvent" } ], "description": "User comment" }, "created": { "allOf": [ { "$ref": "#/components/schemas/CreatedCaseEvent" } ], "description": "Created case event" }, "kpiBreached": { "allOf": [ { "$ref": "#/components/schemas/KPIBreachedCaseEvent" } ], "description": "KPI breach detected for the case" }, "notificationFailed": { "allOf": [ { "$ref": "#/components/schemas/NotificationFailedCaseEvent" } ], "description": "Notification failure" }, "notificationSent": { "allOf": [ { "$ref": "#/components/schemas/NotificationSentCaseEvent" } ], "description": "Notification(s) sent" }, "priorityDetailsChanged": { "allOf": [ { "$ref": "#/components/schemas/PriorityDetailsChangedCaseEvent" } ], "description": "Priority details changed case event" }, "resolutionReasonChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/ResolutionReasonChangedCaseEvent" } ], "description": "Resolution reason changed case event" }, "statusChanged": { "allOf": [ { "$ref": "#/components/schemas/StatusChangedCaseEvent" } ], "description": "Status changed" }, "titleChangedEvent": { "allOf": [ { "$ref": "#/components/schemas/TitleChangedCaseEvent" } ], "description": "Title changed case event" }, "unassigned": { "allOf": [ { "$ref": "#/components/schemas/UnassignedCaseEvent" } ], "description": "Case unassigned from a user" } }, "description": "One-of wrapper for concrete case event types." }, "CaseFilters": { "title": "Case filters", "type": "object", "properties": { "alertFilters": { "allOf": [ { "$ref": "#/components/schemas/AlertFilters" } ], "description": "Alert-based filters applied to cases. When absent, alert ID aggregations are not computed." }, "assignees": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AssigneeOption" }, "description": "List of case assignees to filter on", "examples": [ [ { "unassigned": {} } ] ] }, "breached": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/KPIFilter" }, "description": "KPI-based filters applied to cases. When absent, KPI filter is not applied at all.", "examples": [ [ "KPI_FILTER_NOT_BREACHED" ] ] }, "caseLabelsFilter": { "allOf": [ { "$ref": "#/components/schemas/CaseLabelsFilter" } ], "description": "Filter based on entity labels associated with cases" }, "categories": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CaseCategory" }, "description": "List of case categories to filter on", "examples": [ [ "CASE_CATEGORY_SECURITY", "CASE_CATEGORY_AVAILABILITY" ] ] }, "connectorTypeFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorTypeFilter" }, "description": "Connector type filters applied to cases, including cases with no connector linked.", "examples": [ [ { "connector_type": "CONNECTOR_TYPE_SLACK" }, { "no_connector": {} } ] ] }, "dateRange": { "allOf": [ { "$ref": "#/components/schemas/DateRangeFilter" } ], "description": "Date range filter applied to case active time" }, "groupings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterGroup" }, "description": "Grouping-based filters (e.g., service, subsystem)", "examples": [ [ { "key": "service", "values": [ "payments", "auth" ] } ] ] }, "impactedEntities": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ImpactedEntityFilter" }, "description": "Impacted APM entity filters. A case is returned if it impacts ANY of these entities (OR logic). An empty list applies no filtering.", "examples": [ [ { "apmService": { "name": "payments-api" } }, { "apmDatabase": { "name": "orders-db" } } ] ] }, "indicatorTypes": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IndicatorType" }, "description": "List of indicator types to filter on" }, "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterGroup" }, "description": "Label-based filters applied to cases", "examples": [ [ { "key": "team", "values": [ "backend" ] } ] ] }, "priorities": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CasePriority" }, "description": "List of case priorities to filter on", "examples": [ [ "CASE_PRIORITY_P1", "CASE_PRIORITY_P2" ] ] }, "statuses": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CaseStatus" }, "description": "List of case statuses to filter on" }, "textSearch": { "description": "Test search query applied to case titles", "examples": [ "Vulnerability" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Filters applied when querying cases, including statuses, priorities, categories, groupings, and labels." }, "CaseIndicators": { "title": "Case indicators", "required": [ "alertIndicators" ], "type": "object", "properties": { "alertIndicators": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertIndicator" }, "description": "List of alert indicators contributing to the case" }, "genericIndicators": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GenericIndicator" }, "description": "List of generic indicators contributing to the case" }, "prometheusAlertIndicators": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PrometheusAlertIndicator" }, "description": "List of Prometheus alert indicators contributing to the case" } }, "description": "Grouped indicators contributing to the case." }, "CaseKPIs": { "title": "KPI settings", "type": "object", "properties": { "thresholds": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/KPISettings" }, "description": "List of KPI thresholds for different case priorities." } }, "description": "Case lifecycle KPI thresholds grouped first by KPI type and then by case priority." }, "CaseLabelsFilter": { "title": "Case Labels Filter", "type": "object", "properties": { "flatLabels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.KeyValue" }, "description": "List of case key:value labels to filter on", "examples": [ [ { "key": "region", "value": "us-west-1" } ] ] } }, "description": "Filters applied against Case's labels when queries/filters counted" }, "CaseLifecycle": { "title": "Case lifecycle settings", "type": "object", "properties": { "alertSuppressionStrategy": { "allOf": [ { "$ref": "#/components/schemas/AlertSuppressionStrategy" } ], "description": "Configuration for how cases process suppressed alerts.", "examples": [ "ALERT_SUPPRESSION_STRATEGY_IGNORE" ] }, "autoClose": { "allOf": [ { "$ref": "#/components/schemas/AutoCloseConfig" } ], "description": "Configuration for automatically closing resolved cases after a certain period. If not defined, it will fallback to auto closure after 1 week." }, "autoResolve": { "allOf": [ { "$ref": "#/components/schemas/AutoResolveConfig" } ], "description": "Configuration for inactive cases resolution." }, "kpi": { "allOf": [ { "$ref": "#/components/schemas/CaseKPIs" } ], "description": "KPI thresholds for acknowledgement and resolution, grouped by case priority." }, "resolutionSnoozePeriod": { "description": "Period after resolution during which new cases are snoozed.", "examples": [ "600s" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "suppressionPeriod": { "description": "Default period during which duplicate or related cases are suppressed.", "examples": [ "3600s" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Team-level configuration options for the lifecycle of case, such as suppression and snooze periods." }, "CaseNotificationDeliveries": { "title": "Case notification deliveries", "required": [ "notificationDeliveries" ], "type": "object", "properties": { "notificationDeliveries": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/NotificationDelivery" }, "description": "Notification deliveries for the case" } }, "description": "Notification deliveries for a single case." }, "CaseOrderBy": { "title": "Case ordering specification", "type": "object", "properties": { "direction": { "allOf": [ { "$ref": "#/components/schemas/CaseOrderByDirection" } ], "description": "Order of sorting by field.", "examples": [ "CASE_ORDER_BY_DIRECTION_DESCENDING" ] }, "field": { "allOf": [ { "$ref": "#/components/schemas/CaseOrderByField" } ], "description": "Field by which primary sorting will be performed.", "examples": [ "CASE_ORDER_BY_FIELD_PRIORITY" ] } }, "description": "Defines how cases should be sorted in the response. By default, cases are sorted by creation time and id in descending order. With this field, one can specify the primary sorting field and direction." }, "CaseOrderByDirection": { "title": "Case order direction", "enum": [ "CASE_ORDER_BY_DIRECTION_UNSPECIFIED", "CASE_ORDER_BY_DIRECTION_ASCENDING", "CASE_ORDER_BY_DIRECTION_DESCENDING" ], "type": "string", "description": "Direction in which cases are sorted (ascending or descending)." }, "CaseOrderByField": { "title": "Case order field", "enum": [ "CASE_ORDER_BY_FIELD_UNSPECIFIED", "CASE_ORDER_BY_FIELD_PRIORITY", "CASE_ORDER_BY_FIELD_STATUS", "CASE_ORDER_BY_FIELD_UPDATED_AT", "CASE_ORDER_BY_FIELD_CATEGORY", "CASE_ORDER_BY_FIELD_DURATION", "CASE_ORDER_BY_FIELD_CREATED_AT" ], "type": "string", "description": "Field used for ordering cases (e.g., priority, status, category)." }, "CasePriority": { "enum": [ "CASE_PRIORITY_UNSPECIFIED", "CASE_PRIORITY_P1", "CASE_PRIORITY_P2", "CASE_PRIORITY_P3", "CASE_PRIORITY_P4", "CASE_PRIORITY_P5" ], "type": "string", "description": "Case priority." }, "CaseResolver": { "title": "Case resolver", "type": "object", "oneOf": [ { "required": [ "system" ], "type": "object" }, { "required": [ "cxUser" ], "type": "object" }, { "required": [ "serviceNow" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "prometheusAlertManager" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "system" ], "type": "object" }, { "required": [ "cxUser" ], "type": "object" }, { "required": [ "serviceNow" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "prometheusAlertManager" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" } ] } } ], "properties": { "apiKey": { "allOf": [ { "$ref": "#/components/schemas/CaseResolver.ApiKey" } ], "description": "The api key." }, "cxUser": { "$ref": "#/components/schemas/CoralogixUser" }, "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeams" }, "pagerDuty": { "$ref": "#/components/schemas/PagerDuty" }, "prometheusAlertManager": { "$ref": "#/components/schemas/PrometheusAlertManager" }, "serviceNow": { "$ref": "#/components/schemas/ServiceNow" }, "slack": { "$ref": "#/components/schemas/Slack" }, "system": { "$ref": "#/components/schemas/System" } }, "description": "Entity responsible for resolving the case." }, "CaseResolver.ApiKey": { "title": "API key resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved using an API key." }, "CaseSettings": { "title": "Case settings team configuration", "type": "object", "properties": { "caseLifecycle": { "allOf": [ { "$ref": "#/components/schemas/CaseLifecycle" } ], "description": "Case lifecycle settings for the team" }, "createTime": { "description": "Timestamp when the team configuration was created", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "globalIndicatorSettings": { "allOf": [ { "$ref": "#/components/schemas/GlobalIndicatorSettings" } ], "description": "Settings for the team" }, "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 the team configuration", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ] }, "name": { "description": "Human-readable name for the team configuration", "examples": [ "Default Team Config" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp when the team configuration was last updated", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Team-level configuration entity for case management." }, "CaseStatus": { "enum": [ "CASE_STATUS_UNSPECIFIED", "CASE_STATUS_PENDING_ACTIVATION", "CASE_STATUS_ACTIVE", "CASE_STATUS_ACKNOWLEDGED", "CASE_STATUS_RESOLVED", "CASE_STATUS_CLOSED" ], "type": "string", "description": "Case status." }, "CategoryAggregation": { "title": "Category aggregation", "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/CaseCategory" } ], "description": "Case category" }, "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases in this category", "format": "int64", "examples": [ 13 ] } }, "description": "Count of cases grouped by case category." }, "ChangeAssigneeFailedEvent": { "title": "Change assignee failed event", "type": "object", "properties": { "unknownAssigneeError": { "allOf": [ { "$ref": "#/components/schemas/UnknownAssigneeError" } ], "description": "Error for unknown assignee" } }, "description": "Event recorded when an attempt to reassign a case fails." }, "ChangelogEntry": { "title": "Changelog entry", "type": "object", "properties": { "descriptionMd": { "description": "The description md.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "version": { "description": "Version.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "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." }, "CheckDashboardResponse": { "title": "Check dashboard response data structure", "type": "object", "properties": { "issues": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Issue" }, "description": "List of validation issues; empty when the dashboard is valid" } }, "description": "Validation result containing a list of issues found in the dashboard", "externalDocs": { "description": "Find out more Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "ClearPriorityOverrideResponse": { "title": "Clear priority override response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after removing the priority override." } }, "description": "Response containing the case after clearing its priority override." }, "ClearRole": { "type": "object", "properties": { "clear": { "type": "boolean", "description": "The clear." } }, "description": "Clear role." }, "ClearScope": { "type": "object", "properties": { "clear": { "type": "boolean", "description": "The clear." } }, "description": "Clear scope." }, "CloseCaseResponse": { "title": "Close case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after closing it." } }, "description": "Response containing the case after it has been closed." }, "CloseIncidentsResponse": { "title": "Close incidents response", "required": [ "incidents" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "List of incidents after closing" } }, "description": "Response containing the updated incidents after closing" }, "CloudFormationStack": { "title": "CloudFormation stack", "type": "object", "properties": { "arn": { "description": "The arn.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "region": { "description": "Region.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about the AWS CloudFormation integration in our documentation", "url": "https://coralogix.com/docs/integrations/aws/aws-cloudformation-logs/" } }, "CloudFormationTemplate": { "title": "CloudFormation template", "type": "object", "properties": { "commands": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CommandInformation" }, "description": "The commands." }, "parameters": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The parameters." }, "postInstallationSteps": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The post installation steps." }, "templateUrl": { "description": "The template url.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Cloud formation template." }, "Cloudformation": { "title": "CloudFormation", "type": "object", "additionalProperties": false }, "Code": { "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ], "type": "string" }, "ColorApplyTarget": { "enum": [ "COLOR_APPLY_TARGET_UNSPECIFIED", "COLOR_APPLY_TARGET_VALUE", "COLOR_APPLY_TARGET_BACKGROUND", "COLOR_APPLY_TARGET_ROW" ], "type": "string", "description": "Color apply target." }, "ColorGradientType": { "enum": [ "COLOR_GRADIENT_TYPE_UNSPECIFIED", "COLOR_GRADIENT_TYPE_BLUE", "COLOR_GRADIENT_TYPE_GREEN", "COLOR_GRADIENT_TYPE_RED", "COLOR_GRADIENT_TYPE_THRESHOLD", "COLOR_GRADIENT_TYPE_BLUE_REVERSED", "COLOR_GRADIENT_TYPE_GREEN_REVERSED", "COLOR_GRADIENT_TYPE_RED_REVERSED", "COLOR_GRADIENT_TYPE_THRESHOLD_REVERSED" ], "type": "string", "description": "Color gradient type." }, "ColorLabelMapping": { "title": "ColorLabelMapping", "type": "object", "oneOf": [ { "required": [ "range" ], "type": "object" }, { "required": [ "value" ], "type": "object" }, { "required": [ "regex" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "range" ], "type": "object" }, { "required": [ "value" ], "type": "object" }, { "required": [ "regex" ], "type": "object" } ] } } ], "properties": { "colorBy": { "allOf": [ { "$ref": "#/components/schemas/ColorApplyTarget" } ], "description": "Determines which element to colorize - value text or background" }, "range": { "allOf": [ { "$ref": "#/components/schemas/RangeMapping" } ], "description": "Range-based color mapping using min/max and thresholds" }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexMapping" } ], "description": "Regex pattern-based color mapping" }, "value": { "allOf": [ { "$ref": "#/components/schemas/ColorLabelMapping.ValueMapping" } ], "description": "Exact value-based color mapping" } }, "description": "Reusable color and label mapping configuration supporting range, value, and regex-based mappings" }, "ColorLabelMapping.ValueMapping": { "title": "ValueMapping", "type": "object", "properties": { "sections": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MappingSection" }, "description": "List of exact value-to-display mapping sections" } }, "description": "Exact value-based color and label mapping" }, "ColorSolidType": { "enum": [ "COLOR_SOLID_TYPE_UNSPECIFIED", "COLOR_SOLID_TYPE_BLUE", "COLOR_SOLID_TYPE_GREEN", "COLOR_SOLID_TYPE_RED", "COLOR_SOLID_TYPE_PURPLE", "COLOR_SOLID_TYPE_CYAN", "COLOR_SOLID_TYPE_MAGENTA", "COLOR_SOLID_TYPE_ORANGE", "COLOR_SOLID_TYPE_YELLOW" ], "type": "string", "description": "Color solid type." }, "ColorsBy": { "type": "object", "oneOf": [ { "required": [ "stack" ], "type": "object" }, { "required": [ "groupBy" ], "type": "object" }, { "required": [ "aggregation" ], "type": "object" }, { "required": [ "query" ], "type": "object" }, { "required": [ "category" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "stack" ], "type": "object" }, { "required": [ "groupBy" ], "type": "object" }, { "required": [ "aggregation" ], "type": "object" }, { "required": [ "query" ], "type": "object" }, { "required": [ "category" ], "type": "object" } ] } } ], "properties": { "aggregation": { "$ref": "#/components/schemas/ColorsByAggregation" }, "category": { "$ref": "#/components/schemas/ColorsByCategory" }, "groupBy": { "$ref": "#/components/schemas/ColorsByGroupBy" }, "query": { "$ref": "#/components/schemas/ColorsByQuery" }, "stack": { "$ref": "#/components/schemas/ColorsByStack" } }, "description": "Defines the coloring strategy applied to widget data series." }, "ColorsByAggregation": { "type": "object", "additionalProperties": false, "description": "Colors by aggregation." }, "ColorsByCategory": { "type": "object", "additionalProperties": false, "description": "Colors by category." }, "ColorsByGroupBy": { "type": "object", "additionalProperties": false, "description": "Colors by group by." }, "ColorsByQuery": { "type": "object", "additionalProperties": false, "description": "Colors by query." }, "ColorsByStack": { "type": "object", "additionalProperties": false, "description": "Colors by stack." }, "ColumnWidthEntry": { "type": "object", "properties": { "columnName": { "description": "The column name.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "width": { "description": "The width.", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true } } }, "CommandInformation": { "title": "Command information", "type": "object", "properties": { "command": { "description": "The command.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "language": { "$ref": "#/components/schemas/Language", "x-coralogix-presence": true }, "links": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "List of links." }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "tooltipText": { "description": "The tooltip text.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "CommentAttachment": { "title": "Comment attachment", "type": "object", "oneOf": [ { "required": [ "log" ], "type": "object" }, { "required": [ "customWidget" ], "type": "object" }, { "required": [ "file" ], "type": "object" } ], "properties": { "customWidget": { "allOf": [ { "$ref": "#/components/schemas/CustomDashboardWidgetAttachment" } ], "description": "Custom dashboard widget attachment with screenshot" }, "file": { "allOf": [ { "$ref": "#/components/schemas/FileAttachment" } ], "description": "Generic file attachment" }, "log": { "allOf": [ { "$ref": "#/components/schemas/LogAttachment" } ], "description": "Log entry attachment with content and metadata" } } }, "CommentCaseEvent": { "title": "Comment event", "type": "object", "oneOf": [ { "required": [ "slack" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "slack" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" } ] } } ], "properties": { "attachments": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CommentAttachment" }, "description": "Attachments to the comment" }, "microsoftTeams": { "allOf": [ { "$ref": "#/components/schemas/MicrosoftTeamsCommentMetadata" } ], "description": "Microsoft Teams-specific comment metadata" }, "slack": { "allOf": [ { "$ref": "#/components/schemas/SlackCommentMetadata" } ], "description": "Slack-specific comment metadata" }, "unsafeText": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Comment text. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "Looking into DB timeouts" ] } }, "description": "Event recorded when a user posts a comment on a case." }, "CompanyEnrichmentSettings": { "type": "object", "properties": { "enrichmentAmountLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Maximum number of enrichment rules allowed for the account.", "format": "int64", "examples": [ 5 ] }, "enrichmentsInUse": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of enrichment rules currently in use by the account.", "format": "int64", "examples": [ 2 ] }, "queryOnlyRowLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Row count above which a custom enrichment becomes query-only (usable in queries but not applied at ingest time). Defaults to 10000.", "format": "int64", "examples": [ 10000 ] }, "queryOnlySizeLimitBytes": { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "File size in bytes above which a custom enrichment becomes query-only (usable in queries but not applied at ingest time). Defaults to 524288 (512 KiB).", "examples": [ "524288" ] }, "rowLimit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Maximum number of rows allowed in a custom enrichment file. Defaults to 150000.", "format": "int64", "examples": [ 150000 ] }, "sizeLimitBytes": { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Maximum custom enrichment file size in bytes. Defaults to 20971520 (20 MiB).", "examples": [ "20971520" ] } }, "description": "Company enrichment settings." }, "CompanyIpAccessSettings": { "title": "Company IP access settings", "type": "object", "properties": { "enableCoralogixCustomerSupportAccess": { "allOf": [ { "$ref": "#/components/schemas/CoralogixCustomerSupportAccess" } ], "description": "The Coralogix customer support access setting.", "examples": [ "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED" ] }, "id": { "minLength": 0, "type": "string", "description": "The unique identifier for the company IP access settings. This is typically a company ID.", "examples": [ "d662a2f1-21c3-493c-8f8a-595d3ab05ef3" ] }, "ipAccess": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IpAccess" }, "description": "The list of IP access entries." } } }, "CompanyModelPricing": { "type": "object", "properties": { "companyId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Company identifier." }, "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 pricing record." }, "prices": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelPrice" }, "description": "Map of model name to custom price. Replaces all existing prices on set." } }, "description": "Company-wide custom model pricing configuration." }, "ComparisonOperator": { "enum": [ "COMPARISON_OPERATOR_UNSPECIFIED", "COMPARISON_OPERATOR_GREATER_THAN", "COMPARISON_OPERATOR_GREATER_THAN_OR_EQUALS", "COMPARISON_OPERATOR_LESS_THAN", "COMPARISON_OPERATOR_LESS_THAN_OR_EQUALS" ], "type": "string", "description": "Comparison operator." }, "CompetitionConfig": { "required": [ "competitors" ], "type": "object", "properties": { "competitors": { "description": "Competitor names to watch for.", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Competitor names to watch for." }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the Competition evaluation." }, "ConfigOverrides": { "type": "object", "properties": { "conditionType": { "$ref": "#/components/schemas/notification_center.ConditionType" }, "messageConfig": { "$ref": "#/components/schemas/MessageConfig" }, "payloadType": { "description": "Connector payload schema type.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "ConfigurationBlock": { "title": "Configuration block", "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "ConfigurationFamily": { "required": [ "id", "version", "active" ], "type": "object", "oneOf": [ { "required": [ "raw" ], "type": "object" }, { "required": [ "preset" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "raw" ], "type": "object" }, { "required": [ "preset" ], "type": "object" } ] } } ], "properties": { "active": { "type": "boolean", "description": "Whether this family is eligible for delivery to matching agents. This is not confirmation that an agent has applied it.", "default": false }, "basedOnConfigurationFamilyId": { "description": "Configuration family UUID v7 this family is based on.", "examples": [ "01975ed4-9c18-7a2d-9b4e-426614173999" ], "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", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "examples": [ "Adds an OTLP logs pipeline for the production Linux VMs." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "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.", "examples": [ "01975ed4-9c1b-7c2a-9e5f-526614174001" ] }, "lastActivatedAt": { "description": "Time when this family was last activated.", "examples": [ "2026-10-08T09:41:01.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "preset": { "allOf": [ { "$ref": "#/components/schemas/PresetConfigurationFamily" } ], "description": "Configuration template settings; present when the family has a chartName and observability features." }, "raw": { "allOf": [ { "$ref": "#/components/schemas/RawConfigurationFamily" } ], "description": "Inputs of a configuration family defined directly by its remote configurations; present when the family has no chartName." }, "sources": { "maxItems": 128, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationFamilySource" }, "description": "Immutable inputs that produced this configuration family version." }, "version": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Increasing family version within this group, returned as a string. The initial version is \"1\"; changed configuration content creates a new version.", "examples": [ "2" ] } }, "description": "A versioned collection of Collector configurations and agent selectors. Family IDs identify versions; the group ID stays the same across updates." }, "ConfigurationFamilyCreate": { "type": "object", "oneOf": [ { "required": [ "raw" ], "type": "object" }, { "required": [ "preset" ], "type": "object" } ], "properties": { "active": { "default": false, "description": "Set true to make the configuration available to matching agents. Defaults to false (inactive).", "type": "boolean", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "examples": [ "Adds an OTLP logs pipeline for the production Linux VMs." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "preset": { "allOf": [ { "$ref": "#/components/schemas/PresetConfigurationFamilyCreate" } ], "description": "Configuration template settings; Coralogix generates the remote configurations from them." }, "raw": { "allOf": [ { "$ref": "#/components/schemas/RawConfigurationFamilyCreate" } ], "description": "Configuration family defined directly by its remote configurations, each with an OTel Collector configuration and an agent selector." } }, "description": "An initial version of the group's configurations. Supply raw Collector configurations or preset template settings. The family starts inactive unless active is true." }, "ConfigurationFamilySource": { "required": [ "configurationOverlay" ], "type": "object", "properties": { "configurationOverlay": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlaySource" } ], "description": "Configuration overlay that produced this family version." } }, "description": "An immutable input that produced a configuration family version." }, "ConfigurationFamilyUpdate": { "type": "object", "oneOf": [ { "required": [ "raw" ], "type": "object" }, { "required": [ "preset" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "raw" ], "type": "object" }, { "required": [ "preset" ], "type": "object" } ] } } ], "properties": { "active": { "default": false, "description": "Set true to activate or false to deactivate the latest family. Include family.active in update_mask to apply this value; omitting its value when listed resets it to false.", "type": "boolean", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "examples": [ "Adds an OTLP logs pipeline for the production Linux VMs." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "preset": { "allOf": [ { "$ref": "#/components/schemas/PresetConfigurationFamilyUpdate" } ], "description": "Configuration template settings; a new configuration family version is created only when they change." }, "raw": { "allOf": [ { "$ref": "#/components/schemas/RawConfigurationFamilyUpdate" } ], "description": "Configuration family defined directly by its remote configurations, each with an OTel Collector configuration and an agent selector." } }, "description": "Latest configuration family field values for an update. Only fields listed in update_mask are applied." }, "ConfigurationGroup": { "required": [ "id", "priorityOrder", "archived" ], "type": "object", "properties": { "archived": { "type": "boolean", "description": "Whether this configuration group is archived." }, "description": { "description": "Description of the group's purpose.", "examples": [ "Collector configuration for production Linux virtual machines." ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "family": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationFamily" } ], "description": "Latest configuration family of the 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.", "examples": [ "01975ed4-9c1a-7b3f-8d4e-426614174000" ] }, "name": { "description": "Display name shown in Fleet Management, unique among the team's configuration groups.", "examples": [ "Production Linux VMs" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "priorityOrder": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "description": "Selection priority when multiple configurations match an agent. Higher values take precedence.", "format": "int32", "default": 0, "examples": [ 100 ] }, "tags": { "maxItems": 64, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Tags for organizing the group. Tags do not select agents." }, "description": "Tags for organizing the group. Tags do not select agents.", "examples": [ [ "production" ] ] } }, "description": "A group of versioned Collector configurations. Use its ID for get, update, and archive operations." }, "ConfigurationGroupView": { "enum": [ "CONFIGURATION_GROUP_VIEW_UNSPECIFIED", "CONFIGURATION_GROUP_VIEW_BASIC", "CONFIGURATION_GROUP_VIEW_FULL" ], "type": "string" }, "ConfigurationOverlay": { "required": [ "id", "tags", "archived", "priorityOrder", "active", "versionId", "version", "overlayHash", "schedules" ], "type": "object", "oneOf": [ { "required": [ "custom" ], "type": "object" }, { "required": [ "preset" ], "type": "object" } ], "properties": { "active": { "default": false, "description": "Whether the latest version is active. With schedules, it applies only during their windows.", "type": "boolean", "x-coralogix-presence": true }, "archived": { "description": "Whether this configuration overlay is archived.", "type": "boolean", "x-coralogix-presence": true }, "createdBy": { "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "User that created the configuration overlay." }, "custom": { "allOf": [ { "$ref": "#/components/schemas/CustomConfigurationOverlay" } ], "description": "Custom overlay content of the latest version." }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Configuration overlay UUID v7." }, "name": { "description": "Display name.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "overlayHash": { "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string", "description": "Lowercase hexadecimal SHA-256 hash of the normalized payload: the custom overlay YAML, or the preset JSON." }, "parentVersionId": { "description": "UUID v7 of the version the latest version was created from.", "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "x-coralogix-presence": true }, "preset": { "allOf": [ { "$ref": "#/components/schemas/PresetConfigurationOverlay" } ], "description": "Preset overlay content of the latest version, for ObservabilityFeatures overlays created outside this API." }, "priorityOrder": { "default": 0, "description": "Merge precedence on a shared remote configuration: higher values win, and the newer overlay wins a tie.", "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "x-coralogix-presence": true }, "schedules": { "description": "Activation schedules of the latest version. With schedules, an active overlay applies only during their windows.", "items": { "$ref": "#/components/schemas/ConfigurationOverlaySchedule" }, "maxItems": 10, "minItems": 0, "type": "array", "x-coralogix-collection": "set" }, "tags": { "maxItems": 64, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Tags attached to the configuration overlay." }, "description": "Tags attached to the configuration overlay." }, "version": { "maxLength": 10, "minLength": 1, "pattern": "^[1-9][0-9]*$", "type": "string", "description": "Monotonic number of the latest version." }, "versionId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "UUID v7 of the latest version. Changes when an update creates a version." } }, "description": "Fleet-manager configuration overlay with the content of its latest version. The latest version is the newest unarchived one, or the newest one for an archived overlay." }, "ConfigurationOverlaySchedule": { "required": [ "id", "startAt", "duration", "timeZone", "state", "createdAt", "updatedAt" ], "type": "object", "properties": { "createdAt": { "description": "Time when this schedule was created.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "duration": { "description": "Length of each window.", "maxLength": 23, "minLength": 2, "pattern": "^([1-9][0-9]{0,11}(\\.[0-9]{1,9})?|0\\.[0-9]{1,9})s$", "type": "string", "x-coralogix-presence": true }, "id": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Schedule UUID v7. Changes when startAt, duration, recurrence, or timeZone changes, or when a new version is created." }, "nextActivation": { "description": "Start of the next window. Set only while the schedule is enabled and has a window left.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "recurrence": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlayScheduleRecurrence" } ], "description": "Repeats the window. Absent for a one-off schedule." }, "startAt": { "description": "Start of the first window.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlayScheduleState" } ], "description": "Lifecycle state of the schedule." }, "terminationDate": { "description": "End of a recurring schedule: no window starts at or after it, and a running window ends at it.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "timeZone": { "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_+\\-/]+$", "type": "string", "description": "IANA time zone for daily, weekly, and monthly recurrence.", "default": "UTC" }, "updatedAt": { "description": "Time when this schedule was last updated.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Activation schedule of a configuration overlay." }, "ConfigurationOverlayScheduleCreate": { "required": [ "startAt", "duration" ], "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "duration": { "description": "Positive length of each window, such as \"7200s\". Must be shorter than the recurrence interval; for days, weeks, and months, shorter than the shortest interval in the schedule's time zone, such as a 23-hour daylight-saving day or the shortest month.", "maxLength": 23, "minLength": 2, "pattern": "^([1-9][0-9]{0,11}(\\.[0-9]{1,9})?|0\\.[0-9]{1,9})s$", "type": "string", "x-coralogix-presence": true }, "recurrence": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlayScheduleRecurrence" } ], "description": "Repeats the window. Omit for a one-off schedule." }, "startAt": { "description": "Start of the first window. A new schedule needs a window that starts in the future and before terminationDate.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "terminationDate": { "description": "End of a recurring schedule: no window starts at or after it, and a running window ends at it. Must be in the future when set or changed. Rejected for a one-off schedule.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "timeZone": { "default": "UTC", "description": "IANA time zone for daily, weekly, and monthly recurrence.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_+\\-/]+$", "type": "string", "x-coralogix-presence": true } }, "description": "Activation schedule to create with a configuration overlay." }, "ConfigurationOverlayScheduleRecurrence": { "required": [ "every", "unit" ], "type": "object", "properties": { "every": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Number of units between window starts.", "format": "int32" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlayScheduleRecurrenceUnit" } ], "description": "Interval unit." } }, "description": "Interval between window starts. Days, weeks, and months follow the schedule's time zone: a monthly start on a missing day moves to the month's last day, a start time skipped by a daylight-saving change moves forward, and a repeated one uses the earlier instant." }, "ConfigurationOverlayScheduleRecurrenceUnit": { "title": "Configuration overlay schedule recurrence unit", "enum": [ "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_UNSPECIFIED", "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_MINUTES", "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_HOURS", "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_DAYS", "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_WEEKS", "CONFIGURATION_OVERLAY_SCHEDULE_RECURRENCE_UNIT_MONTHS" ], "type": "string", "description": "Unit of the interval between window starts." }, "ConfigurationOverlayScheduleReplace": { "required": [ "startAt", "duration" ], "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "duration": { "description": "Positive length of each window, such as \"7200s\". Must be shorter than the recurrence interval; for days, weeks, and months, shorter than the shortest interval in the schedule's time zone, such as a 23-hour daylight-saving day or the shortest month.", "maxLength": 23, "minLength": 2, "pattern": "^([1-9][0-9]{0,11}(\\.[0-9]{1,9})?|0\\.[0-9]{1,9})s$", "type": "string", "x-coralogix-presence": true }, "recurrence": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationOverlayScheduleRecurrence" } ], "description": "Repeats the window. Omit for a one-off schedule." }, "startAt": { "description": "Start of the first window. A new schedule needs a window that starts in the future and before terminationDate.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "terminationDate": { "description": "End of a recurring schedule: no window starts at or after it, and a running window ends at it. Must be in the future when set or changed. Rejected for a one-off schedule.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "timeZone": { "default": "UTC", "description": "IANA time zone for daily, weekly, and monthly recurrence.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_+\\-/]+$", "type": "string", "x-coralogix-presence": true } }, "description": "Activation schedule in a replacement schedule list." }, "ConfigurationOverlayScheduleState": { "title": "Configuration overlay schedule state", "enum": [ "CONFIGURATION_OVERLAY_SCHEDULE_STATE_UNSPECIFIED", "CONFIGURATION_OVERLAY_SCHEDULE_STATE_ENABLED", "CONFIGURATION_OVERLAY_SCHEDULE_STATE_PAUSED", "CONFIGURATION_OVERLAY_SCHEDULE_STATE_COMPLETED" ], "type": "string", "description": "PAUSED: the overlay is not active. ENABLED: the schedule applies the overlay during its windows. COMPLETED: the schedule has no windows left." }, "ConfigurationOverlaySource": { "required": [ "overlayId", "overlayVersionId" ], "type": "object", "properties": { "overlayId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Configuration overlay UUID v7.", "examples": [ "01975ed4-9c1d-7e4c-b071-426614174003" ] }, "overlayName": { "description": "Configuration overlay name at read time.", "examples": [ "production-overlay" ], "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "overlayVersionId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Configuration overlay version UUID v7.", "examples": [ "01975ed4-9c1e-7f5d-8182-426614174004" ] } }, "description": "Configuration overlay provenance." }, "ConfigurationOverlayTarget": { "required": [ "id", "sourceConfigurationFamilyId", "overlayConfigurationFamilyId", "sourceRemoteConfigurationId", "overlayRemoteConfigurationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "createdAt": { "description": "Time when this overlay target was created.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "id": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Overlay target UUID v7." }, "overlayConfigurationFamilyId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Generated overlay configuration family UUID v7." }, "overlayRemoteConfigurationId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Generated overlay remote configuration UUID v7." }, "sourceConfigurationFamilyId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Source configuration family UUID v7." }, "sourceRemoteConfigurationId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Source remote configuration UUID v7." }, "updatedAt": { "description": "Time when this overlay target was last updated.", "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Target snapshot entry for a configuration overlay version." }, "ConfigurationOverlayTargetCreate": { "required": [ "remoteConfigurationId" ], "type": "object", "properties": { "remoteConfigurationId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Remote configuration ID (families[].remoteConfigurations[].id in a configuration group, not the group ID). Its family must be active." } }, "description": "Remote-configuration target input used when creating a configuration overlay." }, "ConfigurationOverlayTargetReplace": { "required": [ "remoteConfigurationId" ], "type": "object", "properties": { "remoteConfigurationId": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Remote configuration ID (families[].remoteConfigurations[].id in a configuration group, not the group ID). Its family must be active." } }, "description": "Remote-configuration target input used when replacing configuration overlay targets." }, "ConnectionStatus": { "enum": [ "PENDING", "ACTIVE", "FAILING", "STATUS_UNKNOWN" ], "type": "string", "description": "Connection status." }, "Connector": { "title": "Connector", "required": [ "name", "type" ], "type": "object", "properties": { "configOverrides": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EntityTypeConfigOverrides" }, "description": "The config overrides." }, "connectorConfig": { "$ref": "#/components/schemas/ConnectorConfig" }, "createTime": { "description": "The create time. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "maxLength": 5000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description.", "examples": [ "Connector for team notifications" ] }, "diagnostics": { "allOf": [ { "$ref": "#/components/schemas/Diagnostics" } ], "deprecated": true }, "id": { "description": "Unique identifier.", "examples": [ "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Display name.", "examples": [ "My Slack Connector" ] }, "resolvedConnectorConfig": { "allOf": [ { "$ref": "#/components/schemas/ConnectorConfig" } ], "description": "Read-only full effective config, including backend auto-resolved fields. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "teamId": { "description": "Team identifier. Set by the server; a value sent by the client is ignored.", "examples": [ 12345 ], "format": "int64", "maximum": 4294967295, "minimum": 1, "readOnly": true, "type": "integer", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/notification_center.ConnectorType" }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true } }, "description": "A connector configuration for sending notifications", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ConnectorConfig": { "title": "Connector Config", "type": "object", "properties": { "fields": { "description": "List of fields. The server does not keep the order of the fields.", "items": { "$ref": "#/components/schemas/notification_center.ConnectorConfigField" }, "maxItems": 100, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Configuration for a specific output schema of a connector", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ConnectorConfigSchema": { "type": "object", "properties": { "fields": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorConfigSchemaField" }, "description": "List of fields." } }, "description": "Connector config schema." }, "ConnectorConfigSchemaField": { "type": "object", "properties": { "allowOverrides": { "type": "boolean", "description": "The allow overrides." }, "allowedValues": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The allowed values." }, "description": "The allowed values." }, "default": { "description": "The default.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fieldName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name." }, "fieldType": { "$ref": "#/components/schemas/FieldType" }, "required": { "type": "boolean", "description": "The required." } } }, "ConnectorDetails": { "title": "Connector details", "required": [ "connectorId", "connectorType", "connectorName" ], "type": "object", "properties": { "connectorId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "Unique identifier of the connector", "examples": [ "c1d2e3f4-5678-90ab-cdef-1234567890ab" ] }, "connectorName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name of the connector", "examples": [ "Production Slack" ] }, "connectorType": { "allOf": [ { "$ref": "#/components/schemas/v1.ConnectorType" } ], "description": "Type of the connector" } }, "description": "Details of a notification connector." }, "ConnectorSchema": { "type": "object", "properties": { "connectorConfigSchema": { "$ref": "#/components/schemas/ConnectorConfigSchema" }, "messageConfigSchemas": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/MessageConfigSchema" }, "description": "The message config schemas." }, "supportedPayloadTypes": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The supported payload types." }, "description": "The supported payload types." }, "type": { "$ref": "#/components/schemas/notification_center.ConnectorType" } }, "description": "Connector schema." }, "ConnectorSummary": { "title": "Connector Summary", "required": [ "name", "type" ], "type": "object", "properties": { "configOverrides": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EntityTypeConfigOverrides" }, "description": "The config overrides." }, "connectorConfig": { "$ref": "#/components/schemas/ConnectorConfig" }, "createTime": { "description": "The create time. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "maxLength": 5000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description.", "examples": [ "Connector for team notifications" ] }, "id": { "description": "Unique identifier.", "examples": [ "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Display name.", "examples": [ "My Slack Connector" ] }, "resolvedConnectorConfig": { "allOf": [ { "$ref": "#/components/schemas/ConnectorConfig" } ], "description": "Read-only full effective config, including backend auto-resolved fields. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "teamId": { "description": "The team id. Set by the server; a value sent by the client is ignored.", "examples": [ 12345 ], "format": "int64", "maximum": 4294967295, "minimum": 1, "readOnly": true, "type": "integer", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/notification_center.ConnectorType" }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true } }, "description": "A summary of a connector, excluding sensitive configuration values." }, "ConnectorTypeFilter": { "title": "Connector type filters", "type": "object", "oneOf": [ { "required": [ "connectorType" ], "type": "object" }, { "required": [ "noConnector" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "connectorType" ], "type": "object" }, { "required": [ "noConnector" ], "type": "object" } ] } } ], "properties": { "connectorType": { "$ref": "#/components/schemas/v1.ConnectorType" }, "noConnector": { "$ref": "#/components/schemas/NoConnector" } }, "description": "Filters applied to cases based on connector types." }, "ConnectorTypeSummary": { "title": "Connector Type Summary", "type": "object", "properties": { "count": { "maximum": 800, "minimum": 0, "type": "integer", "description": "Number of items.", "format": "int64", "examples": [ 5 ] }, "type": { "$ref": "#/components/schemas/notification_center.ConnectorType" } }, "description": "Summary information about a connector type", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "Constant": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Constant." }, "ConstantListSource": { "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of values." }, "description": "List of values." } }, "description": "Constant list source." }, "ContextualData": { "title": "Contextual data", "type": "object", "additionalProperties": false }, "ContextualLabelValueWithCount": { "title": "Contextual label value with count", "required": [ "contextualLabelValue", "count" ], "type": "object", "properties": { "contextualLabelValue": { "description": "The contextual label value.", "examples": [ "contextual_label_value" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } }, "ContextualLabelValues": { "title": "Contextual label values", "required": [ "contextualLabelValues" ], "type": "object", "properties": { "contextualLabelValues": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The contextual label values." }, "description": "The contextual label values." } }, "description": "Represents contextual label values for filtering incidents" }, "ContextualLabelValuesWithCount": { "title": "Contextual label values with count", "required": [ "valuesWithCount" ], "type": "object", "properties": { "valuesWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ContextualLabelValueWithCount" }, "description": "The values with count." } } }, "ContextualLabels": { "title": "Incident contextual labels", "required": [ "fieldName", "fieldValue" ], "type": "object", "properties": { "fieldName": { "description": "The field name.", "examples": [ "field_name" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fieldValue": { "description": "The field value.", "examples": [ "field_value" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Contextual labels." }, "CoralogixCustomerSupportAccess": { "enum": [ "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_UNSPECIFIED", "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_DISABLED", "CORALOGIX_CUSTOMER_SUPPORT_ACCESS_ENABLED" ], "type": "string", "description": "Coralogix customer support access." }, "CoralogixUser": { "title": "Coralogix user resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved by a Coralogix user." }, "Count": { "type": "object", "additionalProperties": false, "description": "Count." }, "CountAiAppsPerEvalTypeResponse": { "type": "object", "properties": { "counts": { "type": "object", "additionalProperties": { "minimum": 0, "type": "integer", "format": "int64" }, "description": "Map of evaluation-type name to count of AI applications using it." } }, "description": "Response containing counts of AI applications per evaluation type." }, "CountDistinct": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Count distinct." }, "Counts": { "type": "object", "properties": { "groups": { "description": "List of groups.", "format": "int32", "type": "integer", "x-coralogix-presence": true }, "parsingThemes": { "description": "The parsing themes.", "format": "int32", "type": "integer", "x-coralogix-presence": true }, "rules": { "description": "List of rules.", "format": "int32", "type": "integer", "x-coralogix-presence": true } }, "description": "Counts." }, "CreateActionRequest": { "type": "object", "properties": { "applicationNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The application names." }, "description": "The application names." }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dpxlFilter": { "description": "The dpxl filter.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isPrivate": { "default": true, "description": "Whether only the creating user sees the action. Defaults to true. A private action needs a user, so a request with an API key must set false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 50, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "sourceType": { "$ref": "#/components/schemas/v2.SourceType" }, "subsystemNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The subsystem names." }, "description": "The subsystem names." }, "url": { "description": "URL. Must start with http:// or https://.", "maxLength": 32768, "minLength": 1, "pattern": "^https?://.*$", "type": "string", "x-coralogix-presence": true }, "urlFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UrlField" }, "description": "The url fields. Each field requires both name and required, and names must be unique within the list." } } }, "CreateActionResponse": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/v2.Action" } } }, "CreateAiEvaluationResponse": { "required": [ "aiEvaluation" ], "type": "object", "properties": { "aiEvaluation": { "allOf": [ { "$ref": "#/components/schemas/AiEvaluation" } ], "description": "The newly created AI evaluation." } }, "description": "Response returned after creating an AI evaluation." }, "CreateAlertDefResponse": { "title": "Create alert definition response", "type": "object", "properties": { "alertDef": { "allOf": [ { "$ref": "#/components/schemas/AlertDef" } ], "description": "The newly created alert definition" } }, "description": "A response that contains the newly created alert definition" }, "CreateAlertSchedulerRuleRequest": { "title": "Create alert scheduler rule request data structure", "required": [ "alertSchedulerRule" ], "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "description": "This is a request sent to create 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/" } }, "CreateAlertSchedulerRuleResponse": { "title": "Create alert scheduler rule response data structure", "required": [ "alertSchedulerRule" ], "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "description": "This is a response sent after creating 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/" } }, "CreateApiKeyRequest.KeyPermissions": { "title": "Key Permissions", "type": "object", "properties": { "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions.", "examples": [ "read_logs" ] }, "description": "List of permissions." }, "presets": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permission presets.", "examples": [ "my_preset" ] }, "description": "List of permission presets." } }, "description": "This data structure allows to specify loose permissions and permission presets for an API key.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "CreateApiKeyResponse": { "title": "Create Api Key Response", "type": "object", "properties": { "keyId": { "minLength": 0, "type": "string", "description": "Key identifier.", "examples": [ "my_key_id" ] }, "name": { "minLength": 0, "type": "string", "description": "Display name.", "examples": [ "my_api_key" ] }, "value": { "minLength": 0, "type": "string", "description": "The value.", "examples": [ "my_api_key_value" ] } }, "description": "This data structure is the response obtained when creating an API key.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "CreateBulkAlertSchedulerRuleResponse": { "title": "Create bulk alert scheduler rule response data structure", "required": [ "createSuppressionResponses" ], "type": "object", "properties": { "createSuppressionResponses": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CreateAlertSchedulerRuleResponse" }, "description": "The create suppression responses." } }, "description": "This is a response sent after creating 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/" } }, "CreateCaseSettingsResponse": { "title": "Create case settings response", "required": [ "caseSettings" ], "type": "object", "properties": { "caseSettings": { "allOf": [ { "$ref": "#/components/schemas/CaseSettings" } ], "description": "The created case settings team configuration" } }, "description": "Response containing the newly created case settings team configuration." }, "CreateCommentResponse": { "title": "Create comment event response", "required": [ "event" ], "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" } ], "description": "The created event" } }, "description": "Response returned after successfully creating a comment." }, "CreateCompanyIpAccessSettingsResponse": { "title": "Create company IP access settings response", "type": "object", "properties": { "settings": { "allOf": [ { "$ref": "#/components/schemas/CompanyIpAccessSettings" } ], "description": "The created company IP access settings." } } }, "CreateConnectorResponse": { "title": "Create Connector Response", "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } }, "description": "Response containing the created connector", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "CreateCustomEnrichmentResponse": { "title": "Create Custom Enrichment Response", "type": "object", "properties": { "customEnrichment": { "$ref": "#/components/schemas/CustomEnrichment" }, "message": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message.", "examples": [ "Custom enrichment created successfully" ] } }, "description": "This response data structure is obtained when a custom enrichment is created", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "CreateCustomEvaluationResponse": { "type": "object", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/CustomEvaluation" } ], "description": "The newly created custom evaluation." } }, "description": "Response returned after creating a custom evaluation." }, "CreateCustomPresetResponse": { "title": "Create Custom Preset Response", "type": "object", "properties": { "preset": { "$ref": "#/components/schemas/Preset" } }, "description": "Response containing the created custom preset", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "CreateDashboardFolderResponse": { "title": "Create dashboard folder response data structure", "type": "object", "properties": { "folderId": { "description": "The folder 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", "x-coralogix-presence": true } }, "description": "Response returned after successfully creating a dashboard folder.", "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", "properties": { "dashboardId": { "description": "The dashboard id.", "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "This is a response received when a custom dashboard is successfully created", "externalDocs": { "description": "Find out more Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "CreateE2MRequest": { "title": "Create E2M Request", "required": [ "e2m" ], "type": "object", "properties": { "e2m": { "allOf": [ { "$ref": "#/components/schemas/E2MCreateParams" } ], "description": "The e2m." } }, "description": "This is used to create a new event to metric definition", "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "CreateE2MResponse": { "type": "object", "properties": { "e2m": { "allOf": [ { "$ref": "#/components/schemas/E2M" } ], "description": "The e2m." } }, "description": "Create e2m response." }, "CreateGenericPolicyRequest": { "title": "Create Generic Policy Request", "required": [ "name" ], "type": "object", "properties": { "applicationRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "archiveRetention": { "$ref": "#/components/schemas/ArchiveRetention" }, "description": { "description": "Human-readable description. Only Latin-1 characters are accepted. The atomic overwrite does not default an omitted description, so the policy can read back without one; send an empty string for an empty description.", "examples": [ "My Policy Description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "disabled": { "type": "boolean", "description": "Whether the policy is created disabled. Defaults to `false`. A policy returns the opposite value as `enabled`." }, "name": { "description": "Display name. Only Latin-1 characters are accepted. The names of the policies of one request must be unique: the service rejects a repeated name with `409`.", "examples": [ "My Policy" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/quota.v1.Priority" } ], "description": "The priority of the policy. Set it here, or on every target, not both. With `priorityOverride` and no priority, the policy gets `PRIORITY_TYPE_BLOCK`. The service rejects a policy without a priority, an override, or targets that each have a priority." }, "priorityOverride": { "$ref": "#/components/schemas/PriorityOverride" }, "subsystemRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "targets": { "maxItems": 5, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.Target" }, "description": "List of targets. A log policy without targets is routed to the `logs` dataset of the `default` dataspace, and reads back with that target. Span policies always read back with one `spans` target, and RUM policies reject targets." } }, "description": "This data structue is used to create a new policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "CreateGlobalRouterResponse": { "title": "Create Global Router Response", "type": "object", "properties": { "router": { "$ref": "#/components/schemas/GlobalRouter" } }, "description": "Response which contains a created global router", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "CreateLogPolicyRequest": { "title": "Create Log Policy Request", "required": [ "policy", "logRules" ], "type": "object", "properties": { "logRules": { "$ref": "#/components/schemas/LogRules" }, "policy": { "$ref": "#/components/schemas/CreateGenericPolicyRequest" } }, "description": "This data structue is used to create a new log policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "CreateOutgoingWebhookResponse": { "title": "Create outgoing webhook response", "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "examples": [ "example_id" ], "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Response returned after successfully creating an outgoing webhook." }, "CreatePolicyResponse": { "title": "Create Policy Response", "required": [ "policy" ], "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/Policy" } }, "description": "This data structue is obtained when creating a policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "CreateQuotaAllocationRuleSetResponse": { "title": "Create quota allocation rule set response", "type": "object", "properties": { "ruleSet": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRuleSet" } }, "description": "Response confirming quota allocation rule set has been successfully created" }, "CreateRoleResponse": { "type": "object", "properties": { "id": { "minimum": 0, "type": "integer", "description": "Unique identifier.", "format": "int64" } }, "description": "Response returned after successfully creating a custom role." }, "CreateRuleGroupRequest.CreateRuleSubgroup": { "required": [ "rules", "order" ], "type": "object", "properties": { "enabled": { "default": true, "description": "Whether the subgroup is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "order": { "description": "Position of the subgroup in the group, starting at 1.", "format": "int64", "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "rules": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup.CreateRule" }, "description": "The rules of the subgroup. At least one." } }, "description": "A rule subgroup. The service sets its id, and sets a new one on every update of the group." }, "CreateRuleGroupRequest.CreateRuleSubgroup.CreateRule": { "required": [ "name", "sourceField", "parameters", "order" ], "type": "object", "properties": { "description": { "description": "Human-readable description. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the rule is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "order": { "description": "Position of the rule in its subgroup, starting at 1.", "format": "int64", "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "parameters": { "$ref": "#/components/schemas/RuleParameters" }, "sourceField": { "description": "The field the rule reads: `text`, a `text.` path, or one of `applicationName`, `subsystemName`, `computerName`, `category`, `className`, `methodName`, `threadId`, and `severity`. A rule that deletes its source field must read a `text.` path.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "A parsing rule. The service sets its id, and sets a new one on every update of the group." }, "CreateRuleGroupResponse": { "type": "object", "properties": { "ruleGroup": { "$ref": "#/components/schemas/RuleGroup" } }, "description": "Response returned after successfully creating a parsing rule group." }, "CreateRuleGroupSetResult": { "title": "Create Rule Group Set Result", "required": [ "id" ], "type": "object", "properties": { "id": { "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Unique identifier." } }, "description": "Result of creating a rule group set.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "CreateRumPolicyRequest": { "title": "Create Rum Policy Request", "required": [ "policy", "rumRules" ], "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/CreateGenericPolicyRequest" }, "rumRules": { "$ref": "#/components/schemas/LogRules" } }, "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "CreateScopeResponse": { "title": "Create Scope Response", "required": [ "scope" ], "type": "object", "properties": { "scope": { "$ref": "#/components/schemas/v1.Scope" } }, "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "CreateSloRequest": { "title": "CreateSloRequest", "required": [ "slo" ], "type": "object", "properties": { "silenceDataValidations": { "deprecated": true, "description": "Whether to silence data validations.", "type": "boolean", "x-coralogix-presence": true }, "slo": { "$ref": "#/components/schemas/Slo" } }, "description": "Request to create a new SLO." }, "CreateSloResponse": { "title": "CreateSloResponse", "required": [ "slo" ], "type": "object", "properties": { "slo": { "$ref": "#/components/schemas/Slo" } }, "description": "Response after creating a new SLO." }, "CreateSpanPolicyRequest": { "title": "Create Span Policy Request", "required": [ "policy", "spanRules" ], "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/CreateGenericPolicyRequest" }, "spanRules": { "$ref": "#/components/schemas/SpanRules" } }, "description": "This data structue is used to create a new span policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "CreateTeamGroupResponse": { "title": "CreateTeamGroupResponse", "type": "object", "properties": { "group": { "$ref": "#/components/schemas/TeamGroup" } }, "description": "Response containing the newly created team group.", "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/" } }, "CreateTeamInOrgResponse": { "required": [ "teamId" ], "type": "object", "properties": { "teamId": { "allOf": [ { "$ref": "#/components/schemas/v2.TeamId" } ], "description": "Identifier of the created team." } }, "description": "Response containing the identifier of the created team. Read the team with the get operation." }, "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": { "required": [ "username" ], "type": "object", "properties": { "message": { "description": "Human-readable detail about this outcome. Set where a status alone is not enough, such as `CREATE_USER_STATUS_FAILED`.", "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "status": { "$ref": "#/components/schemas/CreateUserStatus" }, "user": { "allOf": [ { "$ref": "#/components/schemas/rbac.v2.User" } ], "description": "Full details of the created user, as returned by GetUser. Absent when the outcome produced no user, such as an invited user, who has none until the invitation is accepted." }, "userAccountId": { "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "userId": { "description": "Stable id of the user. Absent when the outcome produced no user, such as an invited user, who has none until the invitation is accepted.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "username": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "The username from the request this result belongs to" } } }, "CreateUserStatus": { "enum": [ "CREATE_USER_STATUS_UNSPECIFIED", "CREATE_USER_STATUS_CREATED", "CREATE_USER_STATUS_ALREADY_EXISTS", "CREATE_USER_STATUS_INVITED", "CREATE_USER_STATUS_ALREADY_INVITED", "CREATE_USER_STATUS_DOMAIN_NOT_ALLOWED", "CREATE_USER_STATUS_FAILED" ], "type": "string" }, "CreateUsersResponse": { "title": "CreateUsersResponse", "type": "object", "properties": { "results": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CreateUserResult" }, "description": "Exactly one entry per user in the request, in request order. Each entry also echoes its `username`, so a caller can join on that instead of on position." } }, "description": "Empty response indicating successful processing of all user creation and invitation requests. Ensure failures are returned via gRPC status codes.", "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/" } }, "CreatedCaseEvent": { "title": "Created event", "type": "object", "properties": { "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Previous priority", "examples": [ "CASE_PRIORITY_P3" ] } }, "description": "Created case event." }, "CustomAction": { "type": "object", "properties": { "url": { "description": "Static URL that may contain variables using {{variable_name}} syntax", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Custom action." }, "CustomConfigurationOverlay": { "required": [ "configuration", "targets" ], "type": "object", "properties": { "configuration": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "OpenTelemetry Collector YAML fragment, re-emitted in normalized form (sorted keys, no comments)." }, "targets": { "description": "Target snapshot of this version.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayTarget" }, "maxItems": 256, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Custom overlay content of a version." }, "CustomConfigurationOverlayCreate": { "required": [ "configuration" ], "type": "object", "properties": { "configuration": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "OpenTelemetry Collector YAML fragment merged into each targeted remote configuration. Stored in normalized form (sorted keys, no comments). Must not configure the OpAMP extension." }, "targets": { "description": "Remote configurations the overlay applies to, as a set: duplicates are rejected. An active overlay needs at least one target.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayTargetCreate" }, "maxItems": 256, "minItems": 0, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Custom overlay to create: an OpenTelemetry Collector YAML fragment and its targets." }, "CustomConfigurationOverlayUpdate": { "type": "object", "properties": { "configuration": { "description": "Replacement OpenTelemetry Collector YAML fragment. Creates a new version when its normalized form changes. Must not configure the OpAMP extension.", "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targets": { "description": "Replaces the targets, as a set: duplicates are rejected and reordering alone changes nothing. An empty list removes all targets, which is rejected on an active overlay.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayTargetReplace" }, "maxItems": 256, "minItems": 0, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Custom overlay field values for an update. With custom in update_mask, configuration is required and the content replaces the stored one; omitted targets are cleared. With custom.configuration or custom.targets, only that field changes." }, "CustomDashboardWidgetAttachment": { "title": "Custom dashboard widget attachment", "required": [ "customDashboardId", "widgetId", "widgetScreenshot" ], "type": "object", "properties": { "customDashboardId": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Unique identifier of the custom dashboard. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "dashboard_3f166e9f-3c88-4af2-b52e-138f339dab3e" ] }, "queryLinkSuffix": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL suffix for accessing the widget (not including the Coralogix domain part)", "examples": [ "/dashboards/custom/123/widgets/456?time=123456789" ] }, "widgetId": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Unique identifier of the widget within the dashboard. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "widget_a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] }, "widgetScreenshot": { "allOf": [ { "$ref": "#/components/schemas/FileAttachment" } ], "description": "Screenshot of the widget at the time of attachment" } }, "description": "Attachment containing custom dashboard widget data and screenshot" }, "CustomEnrichment": { "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description." }, "fileName": { "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The file name." }, "fileSize": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The file size.", "format": "int64" }, "id": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Unique identifier.", "format": "int64" }, "isQueryOnly": { "type": "boolean", "description": "The is query only." }, "name": { "maxLength": 255, "minLength": 1, "pattern": "^\\w+$", "type": "string", "description": "Display name. May contain only letters, digits, and underscores." }, "version": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Version number.", "format": "int64" } }, "description": "Custom enrichment." }, "CustomEnrichmentData": { "type": "object", "oneOf": [ { "required": [ "textual" ], "type": "object" }, { "required": [ "binary" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "textual" ], "type": "object" }, { "required": [ "binary" ], "type": "object" } ] } } ], "properties": { "binary": { "description": "Binary content of the enrichment data file encoded as base64. The account's enrichment file size limit applies to the decoded byte size (20971520 bytes / 20 MiB by default); maxLength bounds the base64-encoded string.", "format": "byte", "maxLength": 27962028, "minLength": 0, "pattern": "^[A-Za-z0-9+/]*={0,2}$", "type": "string", "x-coralogix-presence": true }, "definition": { "allOf": [ { "$ref": "#/components/schemas/CustomEnrichment" } ], "description": "The enrichment definition." }, "textual": { "description": "Textual content of the enrichment data file as a UTF-8 string. The account's enrichment file size limit applies to the UTF-8 byte size of the content (20971520 bytes / 20 MiB by default); maxLength is an upper bound in characters.", "maxLength": 20971520, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Custom enrichment data including definition and raw content." }, "CustomEnrichmentType": { "type": "object", "properties": { "id": { "description": "Unique identifier.", "examples": [ 1 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Custom enrichment type." }, "CustomEvaluation": { "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 this custom evaluation is linked to." }, "description": "IDs of AI applications this custom evaluation is linked to." }, "config": { "allOf": [ { "$ref": "#/components/schemas/CustomEvaluationConfig" } ], "description": "Evaluation policy details (instructions, examples, etc.)." }, "description": { "maxLength": 65536, "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}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string", "description": "Unique identifier of the custom evaluation." }, "name": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Display name of the custom evaluation." } }, "description": "A custom evaluation defined in the catalog." }, "CustomEvaluationConfig": { "type": "object", "properties": { "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." }, "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": "Custom evaluation policy details (instructions + examples for the LLM evaluator)." }, "CustomEvaluationExample": { "type": "object", "properties": { "conversation": { "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Example conversation text." }, "score": { "maxLength": 4, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Expected score for this example." } }, "description": "A single labeled example for a custom evaluation." }, "CustomRole": { "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." }, "roleId": { "minimum": 0, "type": "integer", "description": "The role id.", "format": "int64" }, "teamId": { "minimum": 0, "type": "integer", "description": "Team identifier.", "format": "int64" } }, "description": "Custom role." }, "CustomSectionOptions": { "type": "object", "properties": { "collapsed": { "description": "Indicator if the section is collapsed", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "color": { "allOf": [ { "$ref": "#/components/schemas/SectionColor" } ], "description": "Color of the section header" }, "description": { "description": "Short description of a section", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Section custom name", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "repetitiveVar": { "allOf": [ { "$ref": "#/components/schemas/RepetitiveVar" } ], "description": "Variable name that can be applied on section making it repetitive section and other metadata" } }, "description": "Custom section options." }, "CustomTimeSelection": { "required": [ "fromTime", "toTime" ], "type": "object", "properties": { "fromTime": { "description": "The from time.", "examples": [ "2024-01-25T11:31:43.152Z" ], "format": "date-time", "maxLength": 35, "minLength": 1, "type": "string", "x-coralogix-presence": true }, "toTime": { "description": "The to time.", "examples": [ "2024-01-25T11:35:43.152Z" ], "format": "date-time", "maxLength": 35, "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Custom time selection." }, "CxEvent": { "title": "Event", "required": [ "cxEventKey", "cxEventType", "cxEventLabels", "companyId", "cxEventTimestamp", "cxEventPayloadType", "cxEventPayload" ], "type": "object", "properties": { "companyId": { "description": "The company id.", "examples": [ 1 ], "format": "int32", "type": "integer", "x-coralogix-presence": true }, "cxEventDedupKey": { "description": "The cx event dedup key.", "examples": [ "test_dedup_key" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "cxEventKey": { "description": "The cx event key.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "cxEventLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The cx event labels." }, "cxEventMetadata": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The cx event metadata." }, "cxEventPayload": { "type": "object", "description": "The cx event payload." }, "cxEventPayloadType": { "description": "The cx event payload type.", "examples": [ "test_payload_type" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "cxEventTimestamp": { "description": "The cx event timestamp.", "examples": [ "2024-05-05T00:00:00.000Z" ], "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "cxEventType": { "description": "The cx event type.", "examples": [ "test_type" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about events", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "CxEventArray": { "title": "CxEventArray", "required": [ "events" ], "type": "object", "properties": { "events": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CxEvent" }, "description": "List of events." } }, "externalDocs": { "description": "Find out more about events", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "CxEventSingleOrMultiple": { "title": "CxEventSingleOrMultiple", "type": "object", "oneOf": [ { "required": [ "singleEvent" ], "type": "object" }, { "required": [ "multipleEvents" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "singleEvent" ], "type": "object" }, { "required": [ "multipleEvents" ], "type": "object" } ] } } ], "properties": { "multipleEvents": { "$ref": "#/components/schemas/CxEventArray" }, "singleEvent": { "$ref": "#/components/schemas/CxEvent" } } }, "Daily": { "type": "object", "additionalProperties": false, "description": "Daily." }, "Dashboard": { "title": "Dashboard", "required": [ "name", "layout" ], "type": "object", "allOf": [ { "oneOf": [ { "required": [ "off" ], "type": "object" }, { "required": [ "twoMinutes" ], "type": "object" }, { "required": [ "fiveMinutes" ], "type": "object" }, { "required": [ "oneMinute" ], "type": "object" }, { "required": [ "fifteenMinutes" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "off" ], "type": "object" }, { "required": [ "twoMinutes" ], "type": "object" }, { "required": [ "fiveMinutes" ], "type": "object" }, { "required": [ "oneMinute" ], "type": "object" }, { "required": [ "fifteenMinutes" ], "type": "object" } ] } } ] }, { "oneOf": [ { "required": [ "absoluteTimeFrame" ], "type": "object" }, { "required": [ "relativeTimeFrame" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "absoluteTimeFrame" ], "type": "object" }, { "required": [ "relativeTimeFrame" ], "type": "object" } ] } } ] } ], "properties": { "absoluteTimeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrame" } ], "description": "Absolute time frame specifying a fixed start and end time" }, "actions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DashboardAction" }, "description": "A list of public actions that are available within the dashboard context" }, "annotations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Annotation" }, "description": "A list of annotations that can be used within the dashboard's visualizations" }, "description": { "description": "A brief description or summary of the dashboard's purpose or content", "examples": [ "Sample description" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fifteenMinutes": { "$ref": "#/components/schemas/AutoRefreshFifteenMinutes" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/filters.Filter" }, "description": "A list of filters that can be applied to the dashboard's data" }, "fiveMinutes": { "$ref": "#/components/schemas/AutoRefreshFiveMinutes" }, "folderId": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "The folder id." }, "folderPath": { "$ref": "#/components/schemas/FolderPath" }, "id": { "description": "A unique identifier of the dashboard", "examples": [ "GZLHSeqelCbD3I7HbIDtL" ], "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "layout": { "allOf": [ { "$ref": "#/components/schemas/Layout" } ], "description": "The layout configuration for the dashboard's visual elements." }, "name": { "description": "The display name of the dashboard", "examples": [ "Example Name" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "off": { "$ref": "#/components/schemas/AutoRefreshOff" }, "oneMinute": { "$ref": "#/components/schemas/AutoRefreshOneMinute" }, "relativeTimeFrame": { "description": "Relative time frame specifying a duration from the current time", "maxLength": 64, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "slugName": { "description": "A unique slug name serving as an alias for accessing the dashboard", "examples": [ "system-health-monitoring" ], "maxLength": 255, "minLength": 1, "pattern": "^[a-z0-9]+(?:[-_]+[a-z0-9]+)*$", "type": "string", "x-coralogix-presence": true }, "twoMinutes": { "$ref": "#/components/schemas/AutoRefreshTwoMinutes" }, "variables": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Variable" }, "description": "A list of variables that can be used within the dashboard for dynamic content", "deprecated": true }, "variablesV2": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/VariableV2" }, "description": "A list of variables that can be used within the dashboard for dynamic content" } }, "description": "Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.", "externalDocs": { "description": "Learn more about Custom Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "DashboardAction": { "title": "Dashboard Action", "type": "object", "properties": { "dataSource": { "allOf": [ { "$ref": "#/components/schemas/ActionDataSourceType" } ], "description": "Defines the data source type of the action, if applicable", "x-coralogix-presence": true }, "definition": { "allOf": [ { "$ref": "#/components/schemas/ActionDefinition" } ], "description": "Definition of the action" }, "id": { "description": "A unique identifier of the action", "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", "x-coralogix-presence": true }, "name": { "description": "The display name of the action", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "queryId": { "description": "Reference to specific query within a widget, can be null if the action is dashboard wide or related to single query widget", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "shouldOpenInNewWindow": { "description": "Defines if the action should open in a new window or current window in the browser", "type": "boolean", "x-coralogix-presence": true }, "widgetId": { "description": "Reference to specific widget within a dashboard, can be null if the action is dashboard wide", "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", "x-coralogix-presence": true } }, "description": "Public actions that are always available within specific dashboard's context.", "externalDocs": { "description": "Learn more about Custom Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "DashboardCatalogItem": { "title": "Dashboard catalog item data structure", "required": [ "permissions" ], "type": "object", "properties": { "authorId": { "description": "The author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "createTime": { "description": "The create time.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "folder": { "$ref": "#/components/schemas/DashboardFolder" }, "id": { "description": "Unique identifier.", "examples": [ "6U1Q8Hpa263Se8PkRKaiE" ], "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isDefault": { "description": "The is default.", "type": "boolean", "x-coralogix-presence": true }, "isLocked": { "description": "The is locked.", "type": "boolean", "x-coralogix-presence": true }, "isPinned": { "description": "The is pinned.", "type": "boolean", "x-coralogix-presence": true }, "lockerAuthorId": { "description": "The locker author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/DashboardPermissions" } ], "description": "What the caller may do with this dashboard." }, "slugName": { "description": "The slug name.", "maxLength": 255, "minLength": 1, "pattern": "^[a-z0-9]+(?:[-_]+[a-z0-9]+)*$", "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } } }, "DashboardFolder": { "required": [ "name" ], "type": "object", "properties": { "id": { "description": "Unique identifier. A UUID.", "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", "x-coralogix-presence": true }, "name": { "description": "Display name. The service rejects a folder without a name, with an empty name, or with a name longer than 100 characters. Folder names are unique in the company.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "parentId": { "description": "The parent id. A UUID that must differ from this folder's own 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", "x-coralogix-presence": true } }, "description": "Dashboard folder." }, "DashboardPermissions": { "title": "Dashboard permissions", "required": [ "canRead", "canUpdate", "canReadAccessPolicy", "canUpdateAccessPolicy" ], "type": "object", "properties": { "canRead": { "type": "boolean", "description": "Whether the caller may view the resource itself, apart from its access policy." }, "canReadAccessPolicy": { "type": "boolean", "description": "Whether the caller may read the resource's access policy. For a dashboard, the caller holds `team-dashboards:ReadAccessPolicy` together with `team-dashboards:Read` on it, or the break-glass `access-policies:ReadAll`." }, "canUpdate": { "type": "boolean", "description": "Whether the caller may change or delete the resource itself, apart from its access policy." }, "canUpdateAccessPolicy": { "type": "boolean", "description": "Whether the caller may replace the resource's access policy. For a dashboard, the caller holds `team-dashboards:UpdateAccessPolicy` together with `team-dashboards:Update` on it, or the break-glass `access-policies:UpdateAll`." } }, "description": "What the caller may do with this resource. All four flags are always returned." }, "DataTable": { "type": "object", "properties": { "columns": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DataTable.Column" }, "description": "List of column definitions. At least one column is required when the query is a logs query." }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "orderBy": { "allOf": [ { "$ref": "#/components/schemas/OrderingField" } ], "description": "Defines how to order the results in the table" }, "query": { "allOf": [ { "$ref": "#/components/schemas/DataTable.Query" } ], "description": "A query object containing query definition" }, "resultsPerPage": { "description": "How many results are displayed per table page", "examples": [ 10 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "rowStyle": { "allOf": [ { "$ref": "#/components/schemas/RowStyle" } ], "description": "Specifies how rows are displayed" } }, "description": "Data table." }, "DataTable.Column": { "type": "object", "properties": { "field": { "description": "Name of the field to display in the column", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "width": { "description": "Custom width of the column, by default it's automatically adjusted", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } }, "DataTable.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "DataTable.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/LogsQuery.Grouping" } ], "description": "Definition of grouping and aggregations" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "A logs variant of the query" }, "DataTable.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder based", "examples": [ "2" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "DataTable.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/DataTable.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/DataTable.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/DataTable.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/DataTable.SpansQuery" } }, "description": "Discriminated union of possible query types for the data table widget." }, "DataTable.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/SpansQuery.Grouping" } ], "description": "Definition of grouping and aggregations" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search span records" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "DataUsageResponse": { "type": "object", "properties": { "buckets": { "maxItems": 1827, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Bucket" }, "description": "Bucket-first usage results. Daily queries yield one bucket per UTC calendar day; hourly queries yield one bucket per UTC hour." }, "queryRange": { "allOf": [ { "$ref": "#/components/schemas/UsageTimestampRange" } ], "description": "Resolved half-open timestamp range of the query after applying absolute or relative interval semantics." } }, "description": "Bucket-first usage results for the resolved query interval." }, "Dataprime": { "title": "DataprimeQuery", "type": "object", "properties": { "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type" }, "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" } }, "description": "A Dataprime variant of the query" }, "DataprimeAlertQuery": { "title": "DataPrime alert query", "type": "object", "properties": { "query": { "description": "The DataPrime query string", "examples": [ "source logs | filter severity == 'error' | count_agg_key by applicationName" ], "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "A DataPrime query" }, "DataprimeQuery.Type": { "type": "object", "properties": { "queryText": { "$ref": "#/components/schemas/QueryText" } }, "description": "Discriminated union specifying the type of Dataprime query used to fetch variable values." }, "DataprimeSource": { "type": "object", "properties": { "dataModeType": { "$ref": "#/components/schemas/v1.common.DataModeType" }, "labelFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The label fields." }, "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "orientation": { "$ref": "#/components/schemas/AnnotationOrientation" }, "query": { "$ref": "#/components/schemas/common.DataprimeQuery" }, "strategy": { "$ref": "#/components/schemas/DataprimeSource.Strategy" } }, "description": "Dataprime source." }, "DataprimeSource.Strategy": { "type": "object", "oneOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ] } } ], "properties": { "duration": { "allOf": [ { "$ref": "#/components/schemas/DataprimeSource.Strategy.Duration" } ], "description": "Duration." }, "instant": { "$ref": "#/components/schemas/DataprimeSource.Strategy.Instant" }, "range": { "$ref": "#/components/schemas/DataprimeSource.Strategy.Range" } }, "description": "Determines the time strategy for fetching Dataprime results (instant snapshot, fixed range, or sliding window)." }, "DataprimeSource.Strategy.Duration": { "type": "object", "properties": { "durationField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Duration strategy: uses a start timestamp and a duration field to define the annotation span." }, "DataprimeSource.Strategy.Instant": { "type": "object", "properties": { "timestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Instant snapshot strategy: uses a single timestamp field to define the annotation point." }, "DataprimeSource.Strategy.Range": { "type": "object", "properties": { "endTimestampField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Range strategy: uses start and end timestamp fields to define the annotation span." }, "DatasetScope": { "enum": [ "DATASET_SCOPE_UNSPECIFIED", "DATASET_SCOPE_USER_DATA", "DATASET_SCOPE_LABEL", "DATASET_SCOPE_METADATA" ], "type": "string", "description": "Dataset scope." }, "DatasetTarget": { "title": "Dataset Target", "type": "object", "properties": { "dataset": { "maxLength": 100, "minLength": 1, "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_./-]*$", "type": "string", "description": "The dataset name in which the enrichment will be applied.", "examples": [ "dataset1" ] } }, "description": "This data structure represents a target for enrichments. It defines a dataset in which the enrichment will be applied to." }, "Date": { "required": [ "year", "month", "day" ], "type": "object", "properties": { "day": { "maximum": 31, "minimum": 1, "type": "integer", "description": "Day of the month. Must be from 1 to 31 and valid for the year and month.", "format": "int32" }, "month": { "maximum": 12, "minimum": 1, "type": "integer", "description": "Month of the year. Must be from 1 to 12.", "format": "int32" }, "year": { "maximum": 9999, "minimum": 1, "type": "integer", "description": "Year of the date. Must be from 1 to 9999.", "format": "int32" } }, "description": "A full calendar date (year, month, day). All three components are required." }, "DateRangeFilter": { "title": "Date Range Filter", "required": [ "from", "to" ], "type": "object", "properties": { "from": { "description": "Timestamp marking the start of the date range", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "mode": { "allOf": [ { "$ref": "#/components/schemas/DateRangeMode" } ], "description": "Determines how the date range is applied. ACTIVE_WINDOW (default) returns cases active during the range. CREATED_AT returns cases created within the range.", "examples": [ "DATE_RANGE_MODE_ACTIVE_WINDOW" ] }, "to": { "description": "Timestamp marking the end of the date range", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "A filter defining a date range with 'from' and 'to' timestamps." }, "DateRangeMode": { "title": "Date range mode", "enum": [ "DATE_RANGE_MODE_UNSPECIFIED", "DATE_RANGE_MODE_ACTIVE_WINDOW", "DATE_RANGE_MODE_CREATED_AT" ], "type": "string", "description": "Determines how the date range is applied to cases (active window vs creation time)." }, "Day": { "title": "Day", "type": "object", "additionalProperties": false, "description": "Marker selecting a one-day forecast window." }, "DayOfWeek": { "enum": [ "DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED", "DAY_OF_WEEK_TUESDAY", "DAY_OF_WEEK_WEDNESDAY", "DAY_OF_WEEK_THURSDAY", "DAY_OF_WEEK_FRIDAY", "DAY_OF_WEEK_SATURDAY", "DAY_OF_WEEK_SUNDAY" ], "type": "string" }, "DefaultIntegrationDetails": { "title": "Default integration details", "type": "object", "properties": { "registered": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RegisteredInstance" }, "description": "The registered." } }, "description": "Default integration details." }, "DeleteAccessPolicy": { "title": "Delete access policy", "type": "object", "additionalProperties": false, "description": "Marker to remove the alert's access policy entirely; carries no fields. Removal does not assign any replacement — a new access policy and policy owner can be assigned afterward." }, "DeleteActionRequest": { "type": "object", "properties": { "id": { "description": "Unique identifier.", "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", "x-coralogix-presence": true } } }, "DeleteActionResponse": { "type": "object", "additionalProperties": false }, "DeleteAiApplicationResponse": { "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 deleted AI application." } }, "description": "Response returned after deleting an AI application." }, "DeleteAiEvaluationResponse": { "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 deleted AI evaluation." } }, "description": "Response returned after deleting an AI evaluation." }, "DeleteAlertDefResponse": { "title": "Delete alert definition response", "type": "object", "additionalProperties": false, "description": "A response to the deletion of an alert definition" }, "DeleteAlertSchedulerRuleResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting an alert suppression rule." }, "DeleteApiKeyResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting an API key." }, "DeleteApiKeysResponse": { "title": "Delete API Keys Response", "type": "object", "additionalProperties": false, "description": "This data structure is the response obtained after deleting API keys.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "DeleteCaseSettingsResponse": { "title": "Delete case settings response", "type": "object", "additionalProperties": false, "description": "Empty response; success indicated by HTTP status" }, "DeleteCommentResponse": { "title": "Delete comment response", "type": "object", "additionalProperties": false, "description": "Empty response; success indicated by HTTP status" }, "DeleteCompanyIpAccessSettingsResponse": { "title": "Delete company IP access settings response", "type": "object", "additionalProperties": false }, "DeleteCompanyModelPricingResponse": { "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 deleted pricing record." } }, "description": "Response returned after deleting company model pricing." }, "DeleteConnectorResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a notification connector." }, "DeleteContextualDataIntegrationResponse": { "title": "Delete contextual data integration response", "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a contextual data integration." }, "DeleteCustomEnrichmentResponse": { "type": "object", "properties": { "customEnrichmentId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The custom enrichment id.", "format": "int64", "examples": [ 1 ] }, "message": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message.", "examples": [ "Custom enrichment deleted successfully" ] } }, "description": "Response returned after successfully deleting a custom enrichment rule." }, "DeleteCustomEvaluationResponse": { "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 deleted custom evaluation." } }, "description": "Response returned after deleting a custom evaluation." }, "DeleteCustomPresetResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a custom notification preset." }, "DeleteDashboardFolderResponse": { "title": "Delete dashboard folder response data structure", "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a dashboard folder.", "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", "additionalProperties": false, "description": "This is a response received when the dashboard is successfully deleted", "externalDocs": { "description": "Find out more Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "DeleteE2MRequest": { "title": "Delete E2M Request", "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "examples": [ "d6a3658e-78d2-47d0-9b81-b2c551f01b09" ], "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", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "DeleteE2MResponse": { "title": "Delete E2M Request", "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "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", "x-coralogix-presence": true } }, "description": "This data structure is obtained when deleting an existing event to metric definition", "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "DeleteGlobalRouterResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a notification router." }, "DeleteIntegrationResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully removing an integration instance." }, "DeleteOutgoingWebhookResponse": { "title": "Delete outgoing webhook response", "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting an outgoing webhook." }, "DeletePolicyResponse": { "title": "Delete Policy Response", "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true } }, "description": "This data structue is obtained when deleting 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/" } }, "DeleteQuotaAllocationRuleSetResponse": { "title": "Delete quota allocation rule set response", "type": "object", "properties": { "id": { "minLength": 0, "type": "string", "description": "Unique identifier." } }, "description": "Response confirming quota allocation rule set has been successfully deleted" }, "DeleteRoleResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a custom role." }, "DeleteRuleGroupResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a parsing rule group." }, "DeleteScopeResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a data access scope." }, "DeleteSloRequest": { "title": "DeleteSloRequest", "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 0, "type": "string", "description": "Unique identifier." } }, "description": "Request to delete an existing SLO." }, "DeleteSloResponse": { "title": "DeleteSloResponse", "type": "object", "properties": { "effectedSloAlertIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The effected slo alert ids." }, "description": "The effected slo alert ids." } }, "description": "Response after deleting an existing SLO." }, "DeleteTeamGroupResponse": { "title": "DeleteTeamGroupResponse", "type": "object", "properties": { "groupId": { "minimum": 0, "type": "integer", "description": "The group id.", "format": "int64" } }, "description": "Response confirming the successful deletion of a team group and its associated configurations.", "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/" } }, "DeleteTeamResponse": { "type": "object", "additionalProperties": false, "description": "Empty response returned after deleting a team." }, "DeleteViewFolderResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a view folder." }, "DeleteViewResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully deleting a view." }, "Delivery": { "enum": [ "DELIVERY_UNSPECIFIED", "DISABLED", "ERRORS_ONLY" ], "type": "string", "description": "Delivery." }, "DeliveryAttempt": { "title": "Delivery attempt", "required": [ "connector", "outcome" ], "type": "object", "properties": { "connector": { "allOf": [ { "$ref": "#/components/schemas/ConnectorDetails" } ], "description": "The connector that the delivery was sent to" }, "outcome": { "allOf": [ { "$ref": "#/components/schemas/DeliveryOutcome" } ], "description": "Outcome of the delivery attempt" } }, "description": "A single delivery attempt to a specific connector." }, "DeliveryFailure": { "title": "Delivery failure", "required": [ "errorMessage" ], "type": "object", "properties": { "errorMessage": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Error message describing the failure", "examples": [ "Connection timeout after 30s" ] } }, "description": "Failed delivery outcome with error details." }, "DeliveryOutcome": { "title": "Delivery outcome", "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "allOf": [ { "$ref": "#/components/schemas/DeliveryFailure" } ], "description": "Delivery failed" }, "success": { "allOf": [ { "$ref": "#/components/schemas/DeliverySuccess" } ], "description": "Delivery succeeded" } }, "description": "Outcome of a notification delivery attempt." }, "DeliverySuccess": { "title": "Delivery success", "type": "object", "properties": { "evidenceUrl": { "description": "URL to the delivered notification, if available (e.g. Slack message, ServiceNow record)", "examples": [ "https://workspace.slack.com/archives/C01ABC23DEF/p1234567890123456" ], "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Successful delivery outcome with an optional evidence URL." }, "DemistoConfig": { "title": "Demisto configuration", "required": [ "payload" ], "type": "object", "properties": { "payload": { "description": "Raw payload data.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "uuid": { "description": "UUID. Required on Create and Update.", "examples": [ "d838cd7b-087b-40c6-bc33-80997020f5d0" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Demisto config." }, "DeployExtensionResponse": { "title": "Deploy extension response", "type": "object", "properties": { "extensionDeployment": { "$ref": "#/components/schemas/ExtensionDeployment" } }, "description": "Response returned after successfully deploying an extension." }, "DeployedExtension": { "title": "Deployed extension", "type": "object", "properties": { "applications": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The applications." }, "description": "The applications.", "default": [] }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "itemIds": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The item ids." }, "description": "The item ids.", "default": [] }, "subsystems": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The subsystems." }, "description": "The subsystems.", "default": [] }, "summary": { "$ref": "#/components/schemas/DeployedExtensionSummary" }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "DeployedExtensionSummary": { "title": "Deployed extension summary", "type": "object", "properties": { "deployedItemCounts": { "$ref": "#/components/schemas/ItemCounts" } }, "description": "Deployed extension summary." }, "DeployedIntegrationInformation": { "title": "Deployed integration information", "required": [ "id", "definitionKey", "definitionVersion" ], "type": "object", "properties": { "definitionKey": { "description": "The definition key.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "definitionVersion": { "description": "The definition version.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationStatus": { "$ref": "#/components/schemas/IntegrationStatus" }, "parameters": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "description": "The parameters." } }, "description": "Deployed integration information." }, "Deprecation": { "title": "Deprecation", "type": "object", "properties": { "reason": { "description": "Reason.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "replacementExtensions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The replacement extensions." }, "description": "The replacement extensions.", "default": [] } }, "description": "Deprecation." }, "DestinationField": { "enum": [ "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED", "DESTINATION_FIELD_CLASSNAME", "DESTINATION_FIELD_METHODNAME", "DESTINATION_FIELD_THREADID", "DESTINATION_FIELD_SEVERITY", "DESTINATION_FIELD_TEXT" ], "type": "string", "description": "Destination field. The zero value `DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED` means the category field." }, "Diagnostics": { "title": "Connector Diagnostics", "type": "object", "properties": { "delivery": { "allOf": [ { "$ref": "#/components/schemas/Delivery" } ], "description": "Allows to configure what notification data should be written into a dataset." } }, "description": "Allows to configure rules for data written into 'notification.deliveries' dataset", "externalDocs": { "description": "Find out more about datasets", "url": "https://coralogix.com/docs/user-guides/data-layer/datasets/" } }, "Digest": { "title": "Slack digest configuration", "required": [ "type" ], "type": "object", "properties": { "isActive": { "description": "Whether this digest is active. An omitted or false value is absent from Get responses.", "type": "boolean", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/DigestType" } ], "examples": [ "1" ] } } }, "DigestType": { "enum": [ "UNKNOWN", "ERROR_AND_CRITICAL_LOGS", "FLOW_ANOMALIES", "SPIKE_ANOMALIES", "DATA_USAGE" ], "type": "string", "description": "Digest type." }, "DimensionAggregation": { "type": "object", "properties": { "aggregationType": { "$ref": "#/components/schemas/DimensionAggregationType" }, "dimensionField": { "$ref": "#/components/schemas/DimensionField" } }, "description": "Dimension aggregation." }, "DimensionAggregationType": { "enum": [ "DIMENSION_AGGREGATION_TYPE_UNSPECIFIED", "DIMENSION_AGGREGATION_TYPE_UNIQUE_COUNT", "DIMENSION_AGGREGATION_TYPE_ERROR_COUNT" ], "type": "string", "description": "Dimension aggregation type." }, "DimensionField": { "enum": [ "DIMENSION_FIELD_UNSPECIFIED", "DIMENSION_FIELD_TRACE_ID" ], "type": "string", "description": "Dimension field." }, "DisplayLabelValueWithCount": { "title": "Display label value with count", "required": [ "displayLabelValue", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "displayLabelValue": { "description": "The display label value.", "examples": [ "display_label_value" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "DisplayLabelValues": { "title": "Display label values", "required": [ "displayLabelValues" ], "type": "object", "properties": { "displayLabelValues": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The display label values." }, "description": "The display label values." } }, "description": "Represents display label values for filtering incidents" }, "DisplayLabelValuesWithCount": { "title": "Display label values with count", "required": [ "valuesWithCount" ], "type": "object", "properties": { "valuesWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DisplayLabelValueWithCount" }, "description": "The values with count." } } }, "DisplayNameTemplateVariable": { "title": "DisplayNameTemplateVariable", "type": "object", "oneOf": [ { "required": [ "observationField" ], "type": "object" }, { "required": [ "mappedValues" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "observationField" ], "type": "object" }, { "required": [ "mappedValues" ], "type": "object" } ] } } ], "properties": { "mappedValues": { "allOf": [ { "$ref": "#/components/schemas/MappedValues" } ], "description": "Resolve the variable from the color label mapping result" }, "observationField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Resolve the variable from a query datashape field" } }, "description": "A variable that can be referenced inside the display name template, backed by either an observation field or mapped values" }, "DownloadAlertsResponse": { "title": "Download alerts response", "type": "object", "properties": { "content": { "minLength": 0, "pattern": "^[A-Za-z0-9+/]*={0,2}$", "type": "string", "description": "Base64-encoded binary data of the alert definitions", "format": "byte", "examples": [ "SGVsbG8gV29ybGQ=" ] }, "notFoundIds": { "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": "Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message." }, "description": "Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message.", "examples": [ [ "123e4567-e89b-12d3-a456-426614174000" ] ] } }, "description": "A response containing the downloaded alert data" }, "DurationFrequency": { "enum": [ "DURATION_FREQUENCY_UNSPECIFIED", "DURATION_FREQUENCY_MINUTE", "DURATION_FREQUENCY_HOUR", "DURATION_FREQUENCY_DAY" ], "type": "string", "description": "Duration frequency." }, "DurationUnit": { "enum": [ "DURATION_UNIT_UNSPECIFIED", "DURATION_UNIT_HOURS" ], "type": "string", "description": "Duration unit." }, "Dynamic.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/Dataprime" }, "logs": { "$ref": "#/components/schemas/Logs" }, "metrics": { "$ref": "#/components/schemas/Metrics" }, "spans": { "$ref": "#/components/schemas/Spans" } }, "description": "Discriminated union of possible query types for the dynamic widget." }, "Dynamic.QueryDefinition": { "title": "QueryDefinition", "required": [ "id", "query" ], "type": "object", "properties": { "id": { "description": "Unique id of the query definition", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Custom name of the query", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/Dynamic.Query" } ], "description": "Query object" } }, "description": "Query definition for dynamic widget" }, "E2M": { "title": "E2M", "required": [ "id", "name", "type" ], "type": "object", "oneOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" } ] } } ], "properties": { "createTime": { "description": "RFC3339 timestamp of when this E2M was created.", "examples": [ "2022-06-30T12:30:00.000Z" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "dataSource": { "description": "Optional data source in namespace/dataset_name format. If not set, defaults to the standard logs/spans stream.", "examples": [ "my_namespace/my_dataset" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of this E2M.", "examples": [ "avg and max the latency of catalog service" ], "maxLength": 2000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier for this E2M. Required on update requests.", "examples": [ "d6a3658e-78d2-47d0-9b81-b2c551f01b09" ], "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", "x-coralogix-presence": true }, "isInternal": { "description": "Indicates whether this E2M is for internal use only.", "type": "boolean", "x-coralogix-presence": true }, "logsQuery": { "$ref": "#/components/schemas/v2.LogsQuery" }, "metricFields": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v2.MetricField" }, "description": "Metric fields to extract and aggregate from the events." }, "metricLabels": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricLabel" }, "description": "Metric labels to attach to the generated metrics." }, "name": { "description": "Human-readable name for this E2M.", "examples": [ "Service_catalog_latency" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutations": { "$ref": "#/components/schemas/E2MPermutations" }, "spansQuery": { "$ref": "#/components/schemas/v2.SpansQuery" }, "type": { "$ref": "#/components/schemas/E2MType" }, "updateTime": { "description": "RFC3339 timestamp of when this E2M was last updated.", "examples": [ "2022-06-30T12:30:00.000Z" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "E2MAggHistogram": { "title": "E2M Aggregate Histogram", "type": "object", "properties": { "buckets": { "maxItems": 64, "minItems": 0, "type": "array", "items": { "type": "number", "description": "The buckets.", "format": "float", "examples": [ 2 ] }, "description": "The buckets." } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "E2MAggSamples": { "title": "E2M Aggregate Samples", "required": [ "sampleType" ], "type": "object", "properties": { "sampleType": { "$ref": "#/components/schemas/SampleType" } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "E2MCreateParams": { "title": "E2M Create Params", "required": [ "name", "type" ], "type": "object", "oneOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "logsQuery" ], "type": "object" } ] } } ], "properties": { "dataSource": { "description": "Optional data source in namespace/dataset_name format. If not set, defaults to the standard logs/spans stream.", "examples": [ "my_namespace/my_dataset" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description for the new E2M.", "examples": [ "avg and max the latency of catalog service" ], "maxLength": 2000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "logsQuery": { "$ref": "#/components/schemas/v2.LogsQuery" }, "metricFields": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v2.MetricField" }, "description": "Metric fields to create and aggregate from the events." }, "metricLabels": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricLabel" }, "description": "Metric labels to attach to the generated metrics." }, "name": { "description": "Human-readable name for the new E2M.", "examples": [ "Service catalog latency" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permutationsLimit": { "description": "Maximum number of unique metric permutations allowed for this E2M.", "examples": [ 30000 ], "format": "int32", "maximum": 10000000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "spansQuery": { "$ref": "#/components/schemas/v2.SpansQuery" }, "type": { "$ref": "#/components/schemas/E2MType" } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "E2MExecutionRequest": { "type": "object", "oneOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "create" ], "type": "object" }, { "required": [ "replace" ], "type": "object" }, { "required": [ "delete" ], "type": "object" } ] } } ], "properties": { "create": { "$ref": "#/components/schemas/CreateE2MRequest" }, "delete": { "$ref": "#/components/schemas/DeleteE2MRequest" }, "replace": { "$ref": "#/components/schemas/ReplaceE2MRequest" } } }, "E2MExecutionResponse": { "type": "object", "oneOf": [ { "required": [ "created" ], "type": "object" }, { "required": [ "replaced" ], "type": "object" }, { "required": [ "deleted" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "created" ], "type": "object" }, { "required": [ "replaced" ], "type": "object" }, { "required": [ "deleted" ], "type": "object" } ] } } ], "properties": { "created": { "$ref": "#/components/schemas/CreateE2MResponse" }, "deleted": { "$ref": "#/components/schemas/DeleteE2MResponse" }, "replaced": { "$ref": "#/components/schemas/ReplaceE2MResponse" } } }, "E2MPermutations": { "title": "E2M Permutations", "required": [ "limit", "hasExceededLimit" ], "type": "object", "properties": { "hasExceededLimit": { "type": "boolean", "description": "Whether the permutations exceeded the limit. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "limit": { "maximum": 10000000, "minimum": 1, "type": "integer", "description": "Limit.", "format": "int32", "examples": [ 30000 ] } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "E2MType": { "enum": [ "E2M_TYPE_UNSPECIFIED", "E2M_TYPE_LOGS2METRICS", "E2M_TYPE_SPANS2METRICS" ], "type": "string", "description": "E2 m type." }, "EmailGroupConfig": { "title": "Email group configuration", "type": "object", "properties": { "emailAddresses": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Email addresses. The service removes duplicates and keeps the first occurrence order. If omitted on update, this list is cleared." }, "description": "Email addresses. The service removes duplicates and keeps the first occurrence order. If omitted on update, this list is cleared.", "examples": [ [ "example@coralogix.com" ] ] } }, "description": "Email group config." }, "EnabledCount": { "title": "Enabled count", "type": "object", "properties": { "count": { "description": "The count for this enabled status", "examples": [ 25 ], "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "enabled": { "description": "Whether the alert is enabled (true) or disabled (false)", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Count for a specific alert enabled status" }, "EndpointType": { "enum": [ "ENDPOINT_TYPE_DEFAULT_OR_PUBLIC", "ENDPOINT_TYPE_PRIVATE" ], "type": "string", "description": "Endpoint type." }, "Enrichment": { "title": "Enrichment", "required": [ "id", "fieldName", "enrichmentType" ], "type": "object", "properties": { "enrichedFieldName": { "description": "The enriched field name.", "examples": [ "1" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "enrichmentType": { "$ref": "#/components/schemas/EnrichmentType" }, "fieldName": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name.", "examples": [ "1" ] }, "id": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Unique identifier.", "format": "int64", "examples": [ 1 ] }, "selectedColumns": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The selected columns." }, "description": "The selected columns.", "examples": [ [ "city", "population" ] ] }, "targets": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DatasetTarget" }, "description": "The targets for the enrichment", "examples": [ [ { "dataset": "dataset1" } ] ] } }, "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "EnrichmentFieldDefinition": { "type": "object", "properties": { "enrichedFieldName": { "description": "The enriched field name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fieldName": { "description": "The field name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "selectedColumns": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The selected columns." }, "description": "The selected columns." }, "targets": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DatasetTarget" }, "description": "The targets for the enrichment", "examples": [ [ { "dataset": "dataset1" } ] ] } } }, "EnrichmentRequestModel": { "title": "Enrichment Prototype", "required": [ "fieldName", "enrichmentType" ], "type": "object", "properties": { "enrichedFieldName": { "description": "The enriched field name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "enrichmentType": { "$ref": "#/components/schemas/EnrichmentType" }, "fieldName": { "description": "The field name.", "examples": [ "sourceIPs" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "selectedColumns": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The selected columns." }, "description": "The selected columns." }, "targets": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DatasetTarget" }, "description": "The targets for the enrichment", "examples": [ [ { "dataset": "dataset1" } ] ] } }, "description": "The enrichment request model", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "EnrichmentType": { "type": "object", "oneOf": [ { "required": [ "geoIp" ], "type": "object" }, { "required": [ "suspiciousIp" ], "type": "object" }, { "required": [ "aws" ], "type": "object" }, { "required": [ "customEnrichment" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "geoIp" ], "type": "object" }, { "required": [ "suspiciousIp" ], "type": "object" }, { "required": [ "aws" ], "type": "object" }, { "required": [ "customEnrichment" ], "type": "object" } ] } } ], "properties": { "aws": { "$ref": "#/components/schemas/AwsType" }, "customEnrichment": { "$ref": "#/components/schemas/CustomEnrichmentType" }, "geoIp": { "$ref": "#/components/schemas/GeoIpType" }, "suspiciousIp": { "$ref": "#/components/schemas/SuspiciousIpType" } }, "description": "Enrichment type." }, "EntityLabelCount": { "title": "Entity label count", "type": "object", "properties": { "count": { "description": "The count for this entity label value", "examples": [ 28 ], "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "labelKey": { "description": "The entity label key", "examples": [ "environment" ], "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "labelValue": { "description": "The entity label value", "examples": [ "production" ], "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Count for a specific entity label value" }, "EntityLabelFilter": { "title": "All or EntityLabel list", "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/All" }, "values": { "$ref": "#/components/schemas/EntityLabelFilter.Values" } }, "description": "Select all items from a specific list of EntityLabels (Key/Values)." }, "EntityLabelFilter.Values": { "type": "object", "properties": { "items": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.KeyValue" }, "description": "List of EntityLabels (Key/Value) to filter to. Passing empty list here means no alerts will be processed." } }, "description": "An explicit list of entity label key-value pairs to include in the filter." }, "EntityLink": { "title": "Entity link", "required": [ "url" ], "type": "object", "properties": { "url": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL to the entity in the originating system.", "examples": [ "https://app.coralogix.com/error-tracking/issues/abc123" ] } }, "description": "A URL reference to an entity in the originating system." }, "EntityTypeAttachmentType": { "type": "object", "properties": { "defaultEnabled": { "type": "boolean", "description": "Whether this attachment type is included by default when policy is Auto.", "examples": [ true ] }, "name": { "maxLength": 100, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Attachment type identifier (e.g. 'alert_graph', 'log_example').", "examples": [ "alert_graph" ] } }, "description": "Supported attachment type with its default enabled state." }, "EntityTypeConfigOverrides": { "title": "Entity Type Config Overrides", "required": [ "entityType" ], "type": "object", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "fields": { "description": "List of fields. The server does not keep the order of the fields.", "items": { "$ref": "#/components/schemas/TemplatedConnectorConfigField" }, "maxItems": 100, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Configuration field overrides for a specific entity type" }, "Equals.Selection": { "title": "Selection", "type": "object", "oneOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" } ] } } ], "properties": { "all": { "allOf": [ { "$ref": "#/components/schemas/Equals.Selection.AllSelection" } ], "description": "Represents a selection of all values." }, "list": { "allOf": [ { "$ref": "#/components/schemas/Equals.Selection.ListSelection" } ], "description": "Represents a selection from a list of values." } } }, "Equals.Selection.AllSelection": { "title": "AllSelection", "type": "object", "additionalProperties": false, "description": "This data structure indicates that all values are selected." }, "Equals.Selection.ListSelection": { "title": "ListSelection", "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "A list of selected values." }, "description": "A list of selected values." } } }, "Error": { "type": "object", "properties": { "code": { "maximum": 599, "minimum": 100, "type": "integer", "description": "HTTP status code of the error (for example 400, 404, 500).", "format": "int32" }, "message": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description of the error." } }, "description": "Standard error response body returned for a failed request." }, "ErrorBudgetThreshold": { "title": "Error Budget Threshold", "type": "object", "properties": { "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SloThresholdRule" }, "description": "The rules for the error budget threshold" } }, "description": "Error budget threshold definition" }, "EvaluationConfig": { "type": "object", "oneOf": [ { "required": [ "allowedTopics" ], "type": "object" }, { "required": [ "competition" ], "type": "object" }, { "required": [ "hallucinationCompleteness" ], "type": "object" }, { "required": [ "hallucinationContextAdherence" ], "type": "object" }, { "required": [ "hallucinationContextRelevance" ], "type": "object" }, { "required": [ "hallucinationCorrectness" ], "type": "object" }, { "required": [ "pii" ], "type": "object" }, { "required": [ "promptInjection" ], "type": "object" }, { "required": [ "restrictedTopics" ], "type": "object" }, { "required": [ "sexism" ], "type": "object" }, { "required": [ "sqlAllowedTables" ], "type": "object" }, { "required": [ "sqlHallucination" ], "type": "object" }, { "required": [ "sqlReadOnly" ], "type": "object" }, { "required": [ "sqlRestrictedTables" ], "type": "object" }, { "required": [ "toxicity" ], "type": "object" }, { "required": [ "hallucinationTaskAdherence" ], "type": "object" }, { "required": [ "sqlLoad" ], "type": "object" }, { "required": [ "languageMismatch" ], "type": "object" }, { "required": [ "customEvaluation" ], "type": "object" } ], "properties": { "allowedTopics": { "$ref": "#/components/schemas/AllowedTopicsConfig" }, "competition": { "$ref": "#/components/schemas/CompetitionConfig" }, "customEvaluation": { "$ref": "#/components/schemas/CustomEvaluationConfig" }, "hallucinationCompleteness": { "$ref": "#/components/schemas/HallucinationCompletenessConfig" }, "hallucinationContextAdherence": { "$ref": "#/components/schemas/HallucinationContextAdherenceConfig" }, "hallucinationContextRelevance": { "$ref": "#/components/schemas/HallucinationContextRelevanceConfig" }, "hallucinationCorrectness": { "$ref": "#/components/schemas/HallucinationCorrectnessConfig" }, "hallucinationTaskAdherence": { "$ref": "#/components/schemas/HallucinationTaskAdherenceConfig" }, "languageMismatch": { "$ref": "#/components/schemas/LanguageMismatchConfig" }, "pii": { "$ref": "#/components/schemas/PiiConfig" }, "promptInjection": { "$ref": "#/components/schemas/PromptInjectionConfig" }, "restrictedTopics": { "$ref": "#/components/schemas/RestrictedTopicsConfig" }, "sexism": { "$ref": "#/components/schemas/SexismConfig" }, "sqlAllowedTables": { "$ref": "#/components/schemas/SqlAllowedTablesConfig" }, "sqlHallucination": { "$ref": "#/components/schemas/SqlHallucinationConfig" }, "sqlLoad": { "$ref": "#/components/schemas/SqlLoadConfig" }, "sqlReadOnly": { "$ref": "#/components/schemas/SqlReadOnlyConfig" }, "sqlRestrictedTables": { "$ref": "#/components/schemas/SqlRestrictedTablesConfig" }, "toxicity": { "$ref": "#/components/schemas/ToxicityConfig" } }, "description": "Type-specific configuration for an evaluation. Exactly one variant is set." }, "EvaluationTarget": { "enum": [ "PROMPT", "RESPONSE", "CONVERSATION" ], "type": "string", "description": "Target span content the evaluation runs against: PROMPT, RESPONSE, or CONVERSATION." }, "EvaluationType": { "enum": [ "ALLOWED_TOPICS", "COMPETITION", "HALLUCINATION_COMPLETENESS", "HALLUCINATION_CONTEXT_ADHERENCE", "HALLUCINATION_CONTEXT_RELEVANCE", "HALLUCINATION_CORRECTNESS", "PII", "PROMPT_INJECTION", "RESTRICTED_TOPICS", "SEXISM", "SQL_ALLOWED_TABLES", "SQL_HALLUCINATION", "SQL_READ_ONLY", "SQL_RESTRICTED_TABLES", "TOXICITY", "HALLUCINATION_TASK_ADHERENCE", "SQL_LOAD", "LANGUAGE_MISMATCH", "CUSTOM_EVALUATION" ], "type": "string" }, "EventActor": { "title": "Event actor", "type": "object", "oneOf": [ { "required": [ "system" ], "type": "object" }, { "required": [ "user" ], "type": "object" }, { "required": [ "serviceNow" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "prometheusAlertManager" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "system" ], "type": "object" }, { "required": [ "user" ], "type": "object" }, { "required": [ "serviceNow" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "prometheusAlertManager" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" } ] } } ], "properties": { "apiKey": { "allOf": [ { "$ref": "#/components/schemas/ApiKeyActor" } ], "description": "API Key generated event" }, "microsoftTeams": { "allOf": [ { "$ref": "#/components/schemas/MicrosoftTeamsActor" } ], "description": "Microsoft Teams generated event" }, "pagerDuty": { "allOf": [ { "$ref": "#/components/schemas/PagerDutyActor" } ], "description": "PagerDuty generated event" }, "prometheusAlertManager": { "allOf": [ { "$ref": "#/components/schemas/PrometheusAlertManagerActor" } ], "description": "Prometheus Alert Manager generated event" }, "serviceNow": { "allOf": [ { "$ref": "#/components/schemas/ServiceNowActor" } ], "description": "Service Now generated event" }, "slack": { "allOf": [ { "$ref": "#/components/schemas/SlackActor" } ], "description": "Slack generated event" }, "system": { "allOf": [ { "$ref": "#/components/schemas/SystemActor" } ], "description": "System-generated event" }, "user": { "allOf": [ { "$ref": "#/components/schemas/UserActor" } ], "description": "User-generated event" } }, "description": "Actor that initiated the event." }, "EventRecurrenceSource": { "type": "object", "properties": { "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "recurrence": { "$ref": "#/components/schemas/Recurrence" }, "strategy": { "$ref": "#/components/schemas/EventRecurrenceSource.Strategy" } }, "description": "Annotation source driven by recurring calendar events such as weekly deployments or maintenance windows." }, "EventRecurrenceSource.Strategy": { "type": "object", "oneOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "duration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ] } } ], "properties": { "duration": { "allOf": [ { "$ref": "#/components/schemas/EventRecurrenceSource.Strategy.Duration" } ], "description": "Duration." }, "instant": { "$ref": "#/components/schemas/EventRecurrenceSource.Strategy.Instant" } }, "description": "Determines how the recurrence event is rendered: as an instant point or a sliding window duration." }, "EventRecurrenceSource.Strategy.Duration": { "type": "object", "properties": { "duration": { "description": "Duration.", "maxLength": 30, "minLength": 2, "pattern": "^\\d+(\\.\\d+)?s$", "type": "string", "x-coralogix-presence": true }, "startTimeHour": { "description": "The start time hour.", "format": "int32", "maximum": 23, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Renders the recurrence event as a sliding window starting at the configured hour and spanning the given duration." }, "EventRecurrenceSource.Strategy.Instant": { "type": "object", "properties": { "startTimeHour": { "description": "The start time hour.", "format": "int32", "maximum": 23, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Renders the recurrence event as an instant snapshot at the configured start hour." }, "EventStats": { "title": "Alert event statistics data structure", "type": "object", "properties": { "activityAnalysisStats": { "$ref": "#/components/schemas/ActivityAnalysisStats" }, "count": { "description": "Number of items.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "resolvedCount": { "description": "The resolved count.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "resolvedPermutationsSamples": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v3.Permutation" }, "description": "The resolved permutations samples." }, "triggeredCount": { "description": "The triggered count.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "triggeredPermutationsSamples": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v3.Permutation" }, "description": "The triggered permutations samples." } } }, "ExtensionBinary": { "title": "Extension binary", "type": "object", "properties": { "data": { "description": "Data payload.", "maxLength": 5000000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/ExtensionBinary.BinaryType" } } }, "ExtensionBinary.BinaryType": { "enum": [ "KIBANA_INDEX_PATTERN" ], "type": "string", "description": "Type of binary content stored in the extension." }, "ExtensionDeployment": { "title": "Extension deployment", "type": "object", "properties": { "applications": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The applications." }, "description": "The applications.", "default": [] }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "itemIds": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The item ids." }, "description": "The item ids.", "default": [] }, "subsystems": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The subsystems." }, "description": "The subsystems.", "default": [] }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Extension deployment." }, "ExtensionItem": { "title": "Extension item", "type": "object", "properties": { "binaries": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionItemBinary" }, "description": "The binaries.", "default": [] }, "data": { "type": "object", "description": "Data payload." }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "extendedInternalId": { "description": "The extended internal id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isMandatory": { "default": false, "description": "The is mandatory.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissionResource": { "$ref": "#/components/schemas/PermissionResource" }, "stableId": { "description": "The stable id.", "maxLength": 63, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targetDomain": { "$ref": "#/components/schemas/TargetDomain" }, "uniqueId": { "description": "The unique id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "ExtensionItemBinary": { "title": "Extension item binary", "type": "object", "properties": { "data": { "description": "Data payload.", "maxLength": 5000000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fileName": { "description": "The file name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/ExtensionItemBinary.BinaryType" } } }, "ExtensionItemBinary.BinaryType": { "enum": [ "PREVIEW_IMAGE", "KIBANA_DASHBOARD_DEFINITION", "GRAFANA_DASHBOARD_DEFINITION", "ENRICHMENT_CSV", "CX_CUSTOM_DASHBOARD_DEFINITION" ], "type": "string", "description": "Binary type." }, "ExtensionRevision": { "title": "Extension revision", "type": "object", "properties": { "binaries": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionBinary" }, "description": "The binaries.", "default": [] }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "excerpt": { "description": "The excerpt.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationDetails": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IntegrationDetail" }, "description": "The integration details.", "default": [] }, "isTesting": { "default": false, "description": "The is testing.", "type": "boolean", "x-coralogix-presence": true }, "items": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionItem" }, "description": "List of items.", "default": [] }, "labels": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of labels." }, "description": "List of labels.", "default": [] }, "permissionDeniedItems": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionItem" }, "description": "The permission denied items.", "default": [] }, "version": { "description": "Version.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "ExternalUrl": { "title": "External URL", "type": "object", "properties": { "url": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL." } }, "description": "External url." }, "ExtractParameters": { "required": [ "rule" ], "type": "object", "properties": { "rule": { "description": "The regular expression, with named capture groups, applied to the source field. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Extract parameters. The named capture groups of the regular expression become fields of the log." }, "ExtractTimestampParameters": { "required": [ "format" ], "type": "object", "properties": { "format": { "description": "The time format, in the syntax that `standard` names. The service accepts an empty string, for example with a standard that has no format.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "standard": { "$ref": "#/components/schemas/FormatStandard" } }, "description": "Extract timestamp parameters. Sets the log timestamp from the source field." }, "FailedItem": { "title": "Failed item", "type": "object", "properties": { "itemId": { "description": "The item id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "reason": { "description": "Reason.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "remoteId": { "description": "The remote id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "FailedToCreateAlertDef": { "title": "Failed to create alert definition", "required": [ "index", "reason" ], "type": "object", "properties": { "index": { "description": "Zero-based index of the alert definition in the request list that failed to be created", "examples": [ 0 ], "format": "int32", "maximum": 99, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "reason": { "description": "Human-readable explanation of why the alert definition failed to be created", "examples": [ "Alert definition name must not be empty." ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "A reference to an alert definition in the request that failed to be created" }, "FailedToReplaceAlertDef": { "title": "Failed to replace alert definition", "type": "object", "properties": { "id": { "description": "The alert definition ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "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", "x-coralogix-presence": true }, "reason": { "description": "Human-readable explanation of why the alert definition failed to be replaced. May be omitted when no further detail is available.", "examples": [ "Alert definition failed validation." ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "An alert definition id that failed to be replaced" }, "FailureReason": { "enum": [ "FAILURE_REASON_UNSPECIFIED", "INVALID_TEMPLATE", "FIELD_NOT_FOUND", "TEMPLATE_EXCEEDS_MAX_LENGTH", "RENDERED_VALUE_EXCEEDS_MAX_LENGTH" ], "type": "string", "description": "Failure reason." }, "FallbackTarget": { "title": "FallbackTarget", "required": [ "entityType", "target" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/notification_center.EntityType" }, "target": { "$ref": "#/components/schemas/RoutingTarget" } }, "description": "Defines fallback target for notifications not matching any routing rule", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "FieldCondition": { "title": "Field condition", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FieldCondition.ConditionType" }, "values": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FieldCondition.FieldValue" }, "description": "List of values." } }, "description": "Field condition." }, "FieldCondition.ConditionType": { "enum": [ "UNKNOWN", "OR", "AND" ], "type": "string", "description": "Condition type." }, "FieldCondition.FieldValue": { "title": "Field value", "type": "object", "properties": { "fieldName": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name." }, "valuePattern": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The value pattern." } } }, "FieldDataType": { "enum": [ "FIELD_DATA_TYPE_UNSPECIFIED", "FIELD_DATA_TYPE_NUMBER", "FIELD_DATA_TYPE_STRING", "FIELD_DATA_TYPE_BOOLEAN", "FIELD_DATA_TYPE_TIMESTAMP", "FIELD_DATA_TYPE_OBJECT", "FIELD_DATA_TYPE_ARRAY", "FIELD_DATA_TYPE_REGEX", "FIELD_DATA_TYPE_UNION", "FIELD_DATA_TYPE_ENUM" ], "type": "string", "description": "Field data type." }, "FieldInformation": { "title": "Field information", "type": "object", "oneOf": [ { "required": [ "single" ], "type": "object" }, { "required": [ "multiText" ], "type": "object" }, { "required": [ "multipleSelection" ], "type": "object" }, { "required": [ "singleBoolean" ], "type": "object" }, { "required": [ "selection" ], "type": "object" }, { "required": [ "singleNumber" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "single" ], "type": "object" }, { "required": [ "multiText" ], "type": "object" }, { "required": [ "multipleSelection" ], "type": "object" }, { "required": [ "singleBoolean" ], "type": "object" }, { "required": [ "selection" ], "type": "object" }, { "required": [ "singleNumber" ], "type": "object" } ] } } ], "properties": { "allowedPattern": { "description": "Regular expression pattern that the field value must match for validation.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "applicableIf": { "$ref": "#/components/schemas/FieldCondition" }, "documentationReference": { "description": "Link to documentation providing more information about this field.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "groupId": { "description": "Identifier of the UI group this field belongs to for form layout purposes.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "multiText": { "$ref": "#/components/schemas/ListTextValue" }, "multipleSelection": { "$ref": "#/components/schemas/MultipleSelectionValue" }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "placeholder": { "description": "Placeholder text shown in the input field before a value is entered.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "predefined": { "description": "Whether this field has a predefined value that is suggested to the user.", "type": "boolean", "x-coralogix-presence": true }, "readonly": { "description": "Whether this field is read-only and cannot be modified by the user.", "type": "boolean", "x-coralogix-presence": true }, "required": { "description": "Whether this field must be filled in before the integration can be deployed.", "type": "boolean", "x-coralogix-presence": true }, "selection": { "$ref": "#/components/schemas/SelectionValue" }, "single": { "$ref": "#/components/schemas/SingleValue" }, "singleBoolean": { "$ref": "#/components/schemas/SingleBooleanValue" }, "singleNumber": { "$ref": "#/components/schemas/IntegrationRevision.SingleNumericValue" }, "templateParamName": { "description": "Name of the template parameter this field maps to in the deployment template.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "tooltip": { "description": "Tooltip text displayed on hover to provide additional context for this field.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/InputType" }, "upgradeNotice": { "description": "Notice displayed to users when an upgrade is required to use this field.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "visible": { "description": "Whether this field is visible in the integration configuration UI.", "type": "boolean", "x-coralogix-presence": true } } }, "FieldStatistics": { "type": "object", "properties": { "fieldStatistics": { "type": "object", "additionalProperties": { "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string" }, "description": "The field statistics." } } }, "FieldType": { "enum": [ "FIELD_TYPE_UNSPECIFIED", "STRING", "NON_EMPTY_STRING", "KEY_VALUE_PAIRS", "JSON_OBJECT", "DATE", "URL", "ARRAY_OF_STRINGS", "BOOLEAN" ], "type": "string", "description": "Field type." }, "File": { "title": "File", "type": "object", "oneOf": [ { "required": [ "textual" ], "type": "object" }, { "required": [ "binary" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "textual" ], "type": "object" }, { "required": [ "binary" ], "type": "object" } ] } } ], "properties": { "binary": { "description": "Binary content of the file encoded as base64. The account's enrichment file size limit applies to the decoded byte size (20971520 bytes / 20 MiB by default); maxLength bounds the base64-encoded string.", "examples": [ "0xFABB32" ], "format": "byte", "maxLength": 27962028, "minLength": 0, "pattern": "^[A-Za-z0-9+/]*={0,2}$", "type": "string", "x-coralogix-presence": true }, "extension": { "description": "File extension indicating the file format. Only \"csv\" is currently supported.", "examples": [ "csv" ], "maxLength": 3, "minLength": 3, "pattern": "^csv$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Name of the file.", "examples": [ "file_name" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "size": { "description": "Size of the file in bytes.", "examples": [ 100 ], "format": "int64", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "textual": { "description": "Textual content of the file as a UTF-8 string. The account's enrichment file size limit applies to the UTF-8 byte size of the content (20971520 bytes / 20 MiB by default); maxLength is an upper bound in characters.", "examples": [ "row1,row2 value1,value2" ], "maxLength": 20971520, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "FileAttachment": { "title": "File attachment", "required": [ "fileName", "fileId", "isDeleted" ], "type": "object", "properties": { "fileId": { "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 file (same id as used in blobset flow)", "examples": [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301" ] }, "fileName": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Original name of the attached file. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "screenshot_2025-09-22.png" ] }, "isDeleted": { "type": "boolean", "description": "Flag indicating whether the file has been marked as deleted", "examples": [ false ] } }, "description": "Attachment representing a file with metadata" }, "Filter.Equals": { "title": "Equals", "type": "object", "properties": { "selection": { "allOf": [ { "$ref": "#/components/schemas/Equals.Selection" } ], "description": "The selection criteria for the equality comparison." } } }, "Filter.LogsFilter": { "title": "LogsFilter", "type": "object", "properties": { "field": { "description": "The log field to which the filter is applied.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "The observation log field to which the filter is applied." }, "operator": { "allOf": [ { "$ref": "#/components/schemas/Filter.Operator" } ], "description": "An operator used for filtering the logs." } } }, "Filter.NotEquals": { "title": "NotEquals", "type": "object", "properties": { "selection": { "allOf": [ { "$ref": "#/components/schemas/NotEquals.Selection" } ], "description": "The selection criteria for the non-equality comparison." } } }, "Filter.Operator": { "title": "Operator", "type": "object", "oneOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" } ] } } ], "properties": { "equals": { "allOf": [ { "$ref": "#/components/schemas/Filter.Equals" } ], "description": "Equality comparison." }, "notEquals": { "allOf": [ { "$ref": "#/components/schemas/Filter.NotEquals" } ], "description": "Non-equality comparison." } } }, "Filter.Source": { "title": "Source", "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" } ] } } ], "properties": { "logs": { "allOf": [ { "$ref": "#/components/schemas/Filter.LogsFilter" } ], "description": "Filter configuration for logs." }, "metrics": { "allOf": [ { "$ref": "#/components/schemas/MetricsFilter" } ], "description": "Filter configuration for metrics." }, "spans": { "allOf": [ { "$ref": "#/components/schemas/SpansFilter" } ], "description": "Filter configuration for spans." } }, "description": "Defines the type of data the filter applies to." }, "Filter.WidgetScope": { "type": "object", "properties": { "allWidgets": { "$ref": "#/components/schemas/Filter.WidgetScope.AllWidgets" }, "specificWidgets": { "$ref": "#/components/schemas/Filter.WidgetScope.SpecificWidgets" } }, "description": "Annotation.widget scope." }, "Filter.WidgetScope.AllWidgets": { "type": "object", "additionalProperties": false, "description": "Annotation.widget scope.all widgets." }, "Filter.WidgetScope.SpecificWidgets": { "type": "object", "properties": { "widgetIds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UUID" }, "description": "The widget ids." } }, "description": "Annotation.widget scope.specific widgets." }, "FilterAggregation": { "title": "Filter aggregation", "type": "object", "properties": { "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases matching this filter", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/v1.KeyValue" } ], "description": "Key/value filter that this count corresponds to" } }, "description": "Count of cases matching a single key/value filter combination." }, "FilterGroup": { "title": "Filter group", "required": [ "key", "values" ], "type": "object", "properties": { "key": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Key of the filter group (e.g., service, environment)", "examples": [ "service" ] }, "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Values associated with the filter group key" }, "description": "Values associated with the filter group key", "examples": [ [ "payments" ] ] } }, "description": "A filter group containing a key and its possible values." }, "FilterGroupAggregation": { "title": "Filter group aggregation", "required": [ "valueCounts" ], "type": "object", "properties": { "key": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Filter group key", "examples": [ "service" ] }, "valueCounts": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ValueCount" }, "description": "Aggregations per value" } }, "description": "Aggregated case counts for a single filter group key, with one entry per observed value." }, "FilterOptionCounts": { "title": "Filter option counts", "type": "object", "properties": { "enabledCounts": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EnabledCount" }, "description": "Counts for different alert enabled statuses" }, "entityLabelCounts": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EntityLabelCount" }, "description": "Counts for different entity label values" }, "priorityCounts": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PriorityCount" }, "description": "Counts for different alert priorities" }, "statusCounts": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/StatusCount" }, "description": "Counts for different alert statuses" }, "typeCounts": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TypeCount" }, "description": "Counts for different alert types" } }, "description": "Counts for different filter options" }, "FilterOptionCountsEnabledFilter": { "title": "Filter option counts enabled filter", "type": "object", "properties": { "enabled": { "description": "Whether to filter for enabled (true) or disabled (false) alerts", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Filter by alert definition enabled status for counting options" }, "FilterOptionCountsEntityLabelsFilter": { "title": "Filter option counts entity labels filter", "type": "object", "properties": { "entityLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The entity label key-value pairs to filter by" }, "valuesOperator": { "allOf": [ { "$ref": "#/components/schemas/FilterValuesOperator" } ], "description": "Whether all labels must match (AND) or any label can match (OR)", "examples": [ "FILTER_VALUES_OPERATOR_AND" ] } }, "description": "Filter by alert definition entity labels with And/Or options" }, "FilterOptionCountsNameFilter": { "title": "Filter option counts name filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS, CONTAINS)", "examples": [ "FILTER_MATCHER_CONTAINS" ] }, "name": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name(s) of the alert definition - multiple values are OR'd together" }, "description": "The name(s) of the alert definition - multiple values are OR'd together", "examples": [ [ "My Alert", "Another Alert" ] ] } }, "description": "Filter by alert definition names for counting options" }, "FilterOptionCountsPriorityFilter": { "title": "Filter option counts priority filter", "type": "object", "properties": { "priority": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefPriority" }, "description": "The alert priorities to include in the count", "examples": [ [ "ALERT_DEF_PRIORITY_P1", "ALERT_DEF_PRIORITY_P2", "ALERT_DEF_PRIORITY_P3" ] ] } }, "description": "Filter by alert definition priorities" }, "FilterOptionCountsResponse": { "title": "Filter option counts response", "type": "object", "properties": { "counts": { "allOf": [ { "$ref": "#/components/schemas/FilterOptionCounts" } ], "description": "The counts for different filter options" } }, "description": "Response containing counts for different filter options" }, "FilterOptionCountsStatusFilter": { "title": "Filter option counts status filter", "type": "object", "properties": { "matcher": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.FilterMatcher" } ], "description": "The filter operator (EQUALS, NOT_EQUALS)", "examples": [ "FILTER_MATCHER_EQUALS" ] }, "status": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefStatus" }, "description": "The alert statuses to include in the count", "examples": [ [ "ALERT_DEF_STATUS_ALERTING", "ALERT_DEF_STATUS_OK", "ALERT_DEF_STATUS_NO_DATA" ] ] } }, "description": "Filter by alert definition status for counting options" }, "FilterOptionCountsTypeFilter": { "title": "Filter option counts type filter", "type": "object", "properties": { "type": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDefType" }, "description": "The alert types", "examples": [ [ "ALERT_DEF_TYPE_LOGS_THRESHOLD", "ALERT_DEF_TYPE_LOGS_NEW_VALUE", "ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT", "ALERT_DEF_TYPE_TRACING_THRESHOLD" ] ] } }, "description": "Filter by alert definition types for counting options" }, "FilterPathAndValues": { "title": "FilterPathAndValues", "required": [ "path" ], "type": "object", "oneOf": [ { "required": [ "multipleValues" ], "type": "object" }, { "required": [ "filters" ], "type": "object" } ], "properties": { "filters": { "allOf": [ { "$ref": "#/components/schemas/Filters" } ], "description": "The filters." }, "multipleValues": { "$ref": "#/components/schemas/MultipleValues" }, "path": { "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "FilterValuesOperator": { "enum": [ "FILTER_VALUES_OPERATOR_UNSPECIFIED", "FILTER_VALUES_OPERATOR_OR", "FILTER_VALUES_OPERATOR_AND" ], "type": "string" }, "Filters": { "title": "Filters", "required": [ "pathAndValues" ], "type": "object", "properties": { "operator": { "allOf": [ { "$ref": "#/components/schemas/v3.FilterOperator" } ], "examples": [ "FILTER_OPERATOR_OR" ] }, "pathAndValues": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterPathAndValues" } } } }, "First": { "type": "object", "additionalProperties": false, "description": "First." }, "FlowStages": { "title": "Flow stages", "type": "object", "properties": { "flowStagesGroups": { "allOf": [ { "$ref": "#/components/schemas/FlowStagesGroups" } ], "description": "The flow stages groups." }, "timeframeMs": { "description": "The timeframe ms.", "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "timeframeType": { "allOf": [ { "$ref": "#/components/schemas/TimeframeType" } ], "description": "The type of timeframe for the flow alert.", "examples": [ "TIMEFRAME_TYPE_UP_TO" ] } }, "description": "Defines stages in a flow alert" }, "FlowStagesGroup": { "title": "Flow stage group", "type": "object", "properties": { "alertDefs": { "maxItems": 30, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/FlowStagesGroupsAlertDefs" }, "description": "The alert definitions for the flow stage group." }, "alertsOp": { "allOf": [ { "$ref": "#/components/schemas/AlertsOp" } ], "description": "The logical operation to apply to the alerts in the group.", "examples": [ "ALERTS_OP_OR" ] }, "nextOp": { "allOf": [ { "$ref": "#/components/schemas/NextOp" } ], "description": "The logical operation to apply to the next stage.", "examples": [ "NEXT_OP_OR" ] } }, "description": "Defines a group of stages in a flow alert" }, "FlowStagesGroups": { "title": "Flow stage groups", "type": "object", "properties": { "groups": { "maxItems": 30, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FlowStagesGroup" }, "description": "List of groups." } }, "description": "Groups of stages in a flow alert" }, "FlowStagesGroupsAlertDefs": { "title": "Flow stage group alert definitions", "type": "object", "properties": { "id": { "description": "The alert definition ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "not": { "description": "Whether to negate the alert definition or not.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Alert definitions for a flow stage group" }, "FlowType": { "title": "Flow alert type", "type": "object", "properties": { "enforceSuppression": { "description": "The enforce suppression.", "type": "boolean", "x-coralogix-presence": true }, "stages": { "maxItems": 30, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/FlowStages" }, "description": "The stages of the flow alert." } }, "description": "Configuration for flow-based alerts with multiple stages", "externalDocs": { "description": "Learn more about flow alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/flow-alerts/" } }, "FolderPath": { "type": "object", "properties": { "segments": { "maxItems": 2, "minItems": 1, "type": "array", "items": { "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The segments." }, "description": "The segments." } }, "description": "Folder path." }, "ForecastPolicyUsageResponse": { "title": "Forecast Policy Usage Response", "required": [ "estimatedBytes" ], "type": "object", "properties": { "estimatedBytes": { "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "description": "Estimated number of bytes the draft policy would match over the requested time window.", "examples": [ "13251739648" ] }, "usageBuckets": { "maxItems": 10080, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageBucket" }, "description": "Per-bucket breakdown of matched bytes over the requested time window. Empty unless time_bucket_ms was set on the request." } }, "description": "Forecasted usage in bytes for a draft TCO policy, based on bytes matched over a given time window.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "FormatStandard": { "enum": [ "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED", "FORMAT_STANDARD_JAVASDF", "FORMAT_STANDARD_GOLANG", "FORMAT_STANDARD_SECONDSTS", "FORMAT_STANDARD_MILLITS", "FORMAT_STANDARD_MICROTS", "FORMAT_STANDARD_NANOTS" ], "type": "string", "description": "Format standard. The zero value `FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED` means strftime." }, "Gauge.Aggregation": { "enum": [ "AGGREGATION_UNSPECIFIED", "AGGREGATION_LAST", "AGGREGATION_MIN", "AGGREGATION_MAX", "AGGREGATION_AVG", "AGGREGATION_SUM" ], "type": "string", "description": "Aggregation." }, "Gauge.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "Gauge.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/Gauge.Aggregation" } ], "deprecated": true }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of observation fields by which to group the results" }, "logsAggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Aggregation function" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A logs variant of the query" }, "Gauge.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/Gauge.Aggregation" } ], "description": "Aggregation function" }, "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder based", "examples": [ "2" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "Gauge.Query": { "type": "object", "oneOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/Gauge.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/Gauge.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/Gauge.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/Gauge.SpansQuery" } }, "description": "Discriminated union of possible query types for the gauge widget." }, "Gauge.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/Gauge.Aggregation" } ], "deprecated": true }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "Lucene query string to search span records" }, "spansAggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Span query aggregation function" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "Gauge.Threshold": { "title": "Threshold", "type": "object", "properties": { "color": { "description": "Color of the threshold", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "from": { "description": "Minimum bound value of the threshold", "format": "double", "type": "number", "x-coralogix-presence": true }, "label": { "description": "Optional label of the threshold", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Definition of a single gauge threshold" }, "Gauge.ThresholdBy": { "enum": [ "THRESHOLD_BY_UNSPECIFIED", "THRESHOLD_BY_VALUE", "THRESHOLD_BY_BACKGROUND" ], "type": "string", "description": "Threshold by." }, "Gauge.Unit": { "enum": [ "UNIT_UNSPECIFIED", "UNIT_NUMBER", "UNIT_PERCENT", "UNIT_MICROSECONDS", "UNIT_MILLISECONDS", "UNIT_SECONDS", "UNIT_BYTES", "UNIT_KBYTES", "UNIT_MBYTES", "UNIT_GBYTES", "UNIT_BYTES_IEC", "UNIT_KIBYTES", "UNIT_MIBYTES", "UNIT_GIBYTES", "UNIT_EUR_CENTS", "UNIT_EUR", "UNIT_USD_CENTS", "UNIT_USD", "UNIT_CUSTOM", "UNIT_PERCENT_ZERO_ONE", "UNIT_PERCENT_ZERO_HUNDRED", "UNIT_NANOSECONDS", "UNIT_DATETIME_ISO" ], "type": "string", "description": "Unit." }, "GcsConfig": { "title": "GCS Configuration", "type": "object", "properties": { "bucket": { "minLength": 0, "type": "string", "description": "Bucket name." } }, "externalDocs": { "description": "Find out more about metrics cost optimization", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/" } }, "GenericIndicator": { "title": "Generic indicator", "required": [ "id", "externalId", "indicatorType", "status", "priority", "lastTriggeredAt" ], "type": "object", "properties": { "entityLinks": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EntityLink" }, "description": "URLs to the originating entities in the external system." }, "externalId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Opaque reference to the originating entity in the external system.", "examples": [ "et-issue-8827" ] }, "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 of this generic indicator.", "examples": [ "f56645c5-9cd4-4b9f-961f-4f852d8835a0" ] }, "indicatorType": { "allOf": [ { "$ref": "#/components/schemas/GenericIndicatorType" } ], "description": "Sub-type identifying the originating system.", "examples": [ "GENERIC_INDICATOR_TYPE_ERROR_TRACKING" ] }, "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.KeyValue" }, "description": "Arbitrary key-value metadata from the originating system.", "examples": [ [ { "key": "service", "value": "auth" } ] ] }, "lastResolvedAt": { "description": "When present, timestamp when the indicator last resolved.", "examples": [ "2025-09-22T11:05:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "lastTriggeredAt": { "description": "Timestamp when the indicator last triggered.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/IndicatorPriority" } ], "description": "Priority of the indicator at trigger time.", "examples": [ "INDICATOR_PRIORITY_P2" ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/GenericIndicatorStatus" } ], "description": "Current lifecycle status of the indicator.", "examples": [ "GENERIC_INDICATOR_STATUS_TRIGGERED" ] } }, "description": "An indicator sourced from a generic external system (e.g. Error Tracking)." }, "GenericIndicatorStatus": { "title": "Generic indicator status", "enum": [ "GENERIC_INDICATOR_STATUS_UNSPECIFIED", "GENERIC_INDICATOR_STATUS_TRIGGERED", "GENERIC_INDICATOR_STATUS_RESOLVED" ], "type": "string", "description": "Lifecycle status of a generic indicator." }, "GenericIndicatorType": { "title": "Generic indicator type", "enum": [ "GENERIC_INDICATOR_TYPE_UNSPECIFIED", "GENERIC_INDICATOR_TYPE_ERROR_TRACKING" ], "type": "string", "description": "Sub-type of a generic indicator." }, "GenericIntegrationParameters": { "title": "Generic integration parameters", "type": "object", "properties": { "parameters": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "description": "The parameters." } }, "description": "Generic integration parameters." }, "GenericWebhook": { "title": "Generic webhook", "type": "object", "additionalProperties": false }, "GenericWebhookConfig": { "title": "Generic webhook configuration", "required": [ "method" ], "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The headers." }, "method": { "allOf": [ { "$ref": "#/components/schemas/MethodType" } ], "examples": [ "1" ] }, "payload": { "description": "Optional raw payload data. If set, it must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "uuid": { "description": "UUID. Required on Create and Update.", "examples": [ "d838cd7b-087b-40c6-bc33-80997020f5d0" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Generic webhook config." }, "GeoIpType": { "type": "object", "properties": { "withAsn": { "description": "The with asn.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Geo ip type." }, "Geomap": { "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregation" } ], "description": "Determines how data clusters on the geomap will display values. Default should always be set to count to simply provide number of nodes in cluster as a value." }, "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "color": { "allOf": [ { "$ref": "#/components/schemas/GeomapColor" } ], "description": "Color options for the nodes on the geomap, affects cluster scaling as well." }, "config": { "allOf": [ { "$ref": "#/components/schemas/GeomapFieldConfig" } ], "description": "Defines columns which provide required geographic information for the geomap from the query results. Affects location and grouping of the data displayed." }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "minMax": { "allOf": [ { "$ref": "#/components/schemas/MinMax" } ], "description": "Defines min/max values range for the geomap, will affect color and cluster scaling." }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/GeomapTooltip" } ], "description": "Tooltip settings for the widget" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] } }, "description": "Geomap." }, "GeomapAggregation": { "type": "object", "oneOf": [ { "required": [ "count" ], "type": "object" }, { "required": [ "sum" ], "type": "object" }, { "required": [ "min" ], "type": "object" }, { "required": [ "max" ], "type": "object" }, { "required": [ "avg" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "count" ], "type": "object" }, { "required": [ "sum" ], "type": "object" }, { "required": [ "min" ], "type": "object" }, { "required": [ "max" ], "type": "object" }, { "required": [ "avg" ], "type": "object" } ] } } ], "properties": { "avg": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregationFieldBased" } ], "description": "Option that will use selected field in data results, perform AVG aggregation on it across all nodes in a cluster and display that value." }, "count": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregationSimple" } ], "description": "Option that will make geomap clusters simply count the number of nodes in each cluster." }, "max": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregationFieldBased" } ], "description": "Option that will use selected field in data results, perform MAX aggregation on it across all nodes in a cluster and display that value." }, "min": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregationFieldBased" } ], "description": "Option that will use selected field in data results, perform MIN aggregation on it across all nodes in a cluster and display that value." }, "sum": { "allOf": [ { "$ref": "#/components/schemas/GeomapAggregationFieldBased" } ], "description": "Option that will use selected field in data results, perform SUM aggregation on it across all nodes in a cluster and display that value." } }, "description": "Geomap aggregation." }, "GeomapAggregationFieldBased": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Geomap aggregation field based." }, "GeomapAggregationSimple": { "type": "object", "additionalProperties": false, "description": "Geomap aggregation simple." }, "GeomapAllRegionConfig": { "type": "object", "properties": { "regionField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Data for this field should always return valid region strings from any supported cloud provider, aggregating every provider's regions." } }, "description": "Geomap all region config." }, "GeomapAwsRegionConfig": { "type": "object", "properties": { "awsRegionField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Data for this field should always return valid AWS region strings (e.g. us-east-1, us-west-2)." } }, "description": "Geomap aws region config." }, "GeomapColor": { "type": "object", "oneOf": [ { "required": [ "size" ], "type": "object" }, { "required": [ "colorRange" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "size" ], "type": "object" }, { "required": [ "colorRange" ], "type": "object" } ] } } ], "properties": { "colorRange": { "allOf": [ { "$ref": "#/components/schemas/ColorGradientType" } ], "description": "Geomap clusters will have same size, but gradient color will be applied to distinguish data values and/or applied aggregation" }, "size": { "allOf": [ { "$ref": "#/components/schemas/ColorSolidType" } ], "description": "Geomap clusters will scale according to data values and/or applied aggregation, using a solid color" } }, "description": "Geomap color." }, "GeomapCoordinateConfig": { "type": "object", "properties": { "latitudeField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Data for this field should always return valid numeric coordinate (e.g. 45.756)." }, "longitudeField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Data for this field should always return valid numeric coordinate (e.g. -122.4194)." } }, "description": "Geomap coordinate config." }, "GeomapFieldConfig": { "type": "object", "oneOf": [ { "required": [ "coordinateConfig" ], "type": "object" }, { "required": [ "awsRegionConfig" ], "type": "object" }, { "required": [ "ibmRegionConfig" ], "type": "object" }, { "required": [ "allRegionConfig" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "coordinateConfig" ], "type": "object" }, { "required": [ "awsRegionConfig" ], "type": "object" }, { "required": [ "ibmRegionConfig" ], "type": "object" }, { "required": [ "allRegionConfig" ], "type": "object" } ] } } ], "properties": { "allRegionConfig": { "allOf": [ { "$ref": "#/components/schemas/GeomapAllRegionConfig" } ], "description": "Alternative way to provide geographic information, by specifying a region field whose values may come from any supported cloud provider.", "x-stability": "preview" }, "awsRegionConfig": { "allOf": [ { "$ref": "#/components/schemas/GeomapAwsRegionConfig" } ], "description": "Alternative way to provide geographic information, by specifying AWS region field from the query results." }, "coordinateConfig": { "allOf": [ { "$ref": "#/components/schemas/GeomapCoordinateConfig" } ], "description": "Default way to provide geographic information, by specifying latitude and longitude fields from the query results." }, "ibmRegionConfig": { "allOf": [ { "$ref": "#/components/schemas/GeomapIbmRegionConfig" } ], "description": "Alternative way to provide geographic information, by specifying an IBM Cloud region field from the query results.", "x-stability": "preview" } }, "description": "Geomap field config." }, "GeomapIbmRegionConfig": { "type": "object", "properties": { "regionField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Data for this field should always return valid IBM Cloud region strings (e.g. us-south, eu-de)." } }, "description": "Geomap ibm region config." }, "GeomapTooltip": { "type": "object", "properties": { "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "Labels to display on the tooltip, should reference fields from clusters or points on the map." }, "messageTemplate": { "description": "Custom template for the geomap tooltip", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Geomap tooltip." }, "GetActionResponse": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/v2.Action" } } }, "GetActiveCaseSettingsResponse": { "title": "Get active case settings response", "required": [ "caseSettings" ], "type": "object", "properties": { "caseSettings": { "allOf": [ { "$ref": "#/components/schemas/CaseSettings" } ], "description": "The active case settings" } }, "description": "Response containing the case settings team configuration currently active for the caller." }, "GetAiApplicationByIdResponse": { "type": "object", "properties": { "aiApplication": { "allOf": [ { "$ref": "#/components/schemas/AiApplication" } ], "description": "The AI application." } }, "description": "Response containing the requested AI application." }, "GetAiEvaluationResponse": { "required": [ "aiEvaluation" ], "type": "object", "properties": { "aiEvaluation": { "allOf": [ { "$ref": "#/components/schemas/AiEvaluation" } ], "description": "The requested AI evaluation." } }, "description": "Response containing the requested AI evaluation." }, "GetAlertDefByVersionIdResponse": { "title": "Get alert definition by version ID response", "type": "object", "properties": { "access": { "allOf": [ { "$ref": "#/components/schemas/AlertDefAccess" } ], "description": "The caller's access decision and the alert's raw access policy" }, "alertDef": { "allOf": [ { "$ref": "#/components/schemas/AlertDef" } ], "description": "The requested alert definition" } }, "description": "A response that contains an alert definition for the requested version" }, "GetAlertDefResponse": { "title": "Get alert definition response", "type": "object", "properties": { "access": { "allOf": [ { "$ref": "#/components/schemas/AlertDefAccess" } ], "description": "The caller's access decision and the alert's raw access policy" }, "alertDef": { "allOf": [ { "$ref": "#/components/schemas/AlertDef" } ], "description": "The requested alert definition" } }, "description": "A response containing the requested alert definition" }, "GetAlertEventResponse": { "title": "Get alert event response", "type": "object", "oneOf": [ { "required": [ "singlePermutation" ], "type": "object" }, { "required": [ "multiplePermutation" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "singlePermutation" ], "type": "object" }, { "required": [ "multiplePermutation" ], "type": "object" } ] } } ], "properties": { "id": { "description": "Unique identifier of the alert event.", "maxLength": 36, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "multiplePermutation": { "$ref": "#/components/schemas/AlertEventMultiplePermutation" }, "pagination": { "$ref": "#/components/schemas/alerts.v3.PaginationResponse" }, "singlePermutation": { "$ref": "#/components/schemas/AlertEvent" } }, "description": "Response containing the details of an alert event." }, "GetAlertEventStatsResponse": { "title": "Get alert event statistics response", "type": "object", "properties": { "eventsStats": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EventStats" }, "description": "The events stats." } }, "description": "Response containing statistical data for alert events." }, "GetAlertSchedulerRuleResponse": { "title": "Get alert scheduler rule response data structure", "required": [ "alertSchedulerRule" ], "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "description": "This is a response 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/" } }, "GetAllExtensionsRequest.Filter": { "title": "A filter structure for a request to get all extensions", "type": "object", "properties": { "integrations": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The integrations." }, "description": "The integrations.", "default": [] } }, "description": "Filter by integration ids" }, "GetAllExtensionsResponse": { "title": "Get all extensions response", "type": "object", "properties": { "extensions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GetAllExtensionsResponse.Extension" }, "description": "The extensions.", "default": [] } }, "description": "Response to list all extensions" }, "GetAllExtensionsResponse.Extension": { "title": "Extension", "type": "object", "properties": { "darkModeImage": { "description": "The dark mode image.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "deprecation": { "$ref": "#/components/schemas/Deprecation" }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "image": { "description": "Image reference.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrations": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The integrations." }, "description": "The integrations.", "default": [] }, "isHidden": { "default": false, "description": "The is hidden.", "type": "boolean", "x-coralogix-presence": true }, "keywords": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The keywords." }, "description": "The keywords.", "default": [] }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "revisions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GetAllExtensionsResponse.Revision" }, "description": "The revisions.", "default": [] } } }, "GetAllExtensionsResponse.Revision": { "title": "Revision", "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "excerpt": { "description": "The excerpt.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationDetails": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IntegrationDetail" }, "description": "The integration details.", "default": [] }, "labels": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of labels." }, "description": "List of labels.", "default": [] }, "summary": { "$ref": "#/components/schemas/GetAllExtensionsResponse.RevisionSummary" }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "GetAllExtensionsResponse.RevisionSummary": { "title": "Revision summary", "type": "object", "properties": { "isNew": { "default": false, "description": "The is new.", "type": "boolean", "x-coralogix-presence": true }, "itemCounts": { "$ref": "#/components/schemas/ItemCounts" } }, "description": "Revision summary." }, "GetApiKeyResponse": { "title": "Get Api Key Response", "type": "object", "properties": { "keyInfo": { "$ref": "#/components/schemas/KeyInfo" } }, "description": "This data structure is the response obtained when retrieving an API key.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "GetApiKeysResponse": { "title": "Get Api Keys Response", "type": "object", "properties": { "keys": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/KeyInfo" }, "description": "The keys." } }, "description": "This data structure is the response obtained when retrieving all API keys.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "GetBulkAlertSchedulerRuleResponse": { "title": "Get bulk alert scheduler rule response data structure", "required": [ "alertSchedulerRules" ], "type": "object", "properties": { "alertSchedulerRules": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertSchedulerRuleWithActiveTimeframe" }, "description": "The alert scheduler rules." }, "nextPageToken": { "minLength": 0, "type": "string", "description": "Token for fetching the next page of results." } }, "description": "This is a response sent after getting 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/" } }, "GetCaseByIndicatorResponse": { "title": "Get case by indicator response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "The case associated with the indicator." } }, "description": "Response containing the case associated with the given indicator." }, "GetCaseDeepLinksResponse": { "title": "Get case deep links response", "required": [ "deepLinks" ], "type": "object", "properties": { "deepLinks": { "allOf": [ { "$ref": "#/components/schemas/CaseDeepLinks" } ], "description": "Deep links for the case." } }, "description": "Response containing the deep links for the requested case" }, "GetCaseResponse": { "title": "Get case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "The requested case" } }, "description": "Response containing the requested case" }, "GetCaseSettingsResponse": { "title": "Get case settings response", "required": [ "caseSettings" ], "type": "object", "properties": { "caseSettings": { "allOf": [ { "$ref": "#/components/schemas/CaseSettings" } ], "description": "The requested case settings team configuration" } }, "description": "Response containing the requested case settings team configuration." }, "GetCompanyEnrichmentSettingsResponse": { "type": "object", "properties": { "enrichmentSettings": { "$ref": "#/components/schemas/CompanyEnrichmentSettings" } }, "description": "Response containing the company-level enrichment settings." }, "GetCompanyIpAccessSettingsResponse": { "title": "Get company IP access settings response", "type": "object", "properties": { "settings": { "allOf": [ { "$ref": "#/components/schemas/CompanyIpAccessSettings" } ], "description": "The company IP access settings." } } }, "GetCompanyModelPricingResponse": { "type": "object", "properties": { "pricing": { "allOf": [ { "$ref": "#/components/schemas/CompanyModelPricing" } ], "description": "The company's custom model pricing." } }, "description": "Response containing the company's custom model pricing." }, "GetCompanyPoliciesResponse": { "title": "Get Company Policies Response", "required": [ "policies" ], "type": "object", "properties": { "policies": { "maxItems": 30000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Policy" }, "description": "List of policies." } }, "description": "This data structue is obtained when retrieving all policies of a company.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "GetCompanyUsageLimitsResponse": { "type": "object", "properties": { "companyId": { "description": "The company id.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "limits": { "$ref": "#/components/schemas/Counts" }, "usage": { "$ref": "#/components/schemas/Counts" } }, "description": "Response containing the company-level rule usage limits." }, "GetConfigurationResponse": { "title": "Get Configuration Response", "type": "object", "properties": { "idpDetails": { "$ref": "#/components/schemas/IDPDetails" }, "idpParameters": { "$ref": "#/components/schemas/IDPParameters" }, "spParameters": { "$ref": "#/components/schemas/SPParameters" }, "teamId": { "minimum": 0, "type": "integer", "description": "The team id.", "format": "int64" } }, "description": "This data structure is obtained as a response to a request 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/" } }, "GetConnectorResponse": { "title": "Get Connector Response", "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } }, "description": "Response containing the requested connector", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "GetConnectorSchemaResponse": { "type": "object", "properties": { "connectorSchema": { "$ref": "#/components/schemas/ConnectorSchema" } }, "description": "Response containing the schema definition for a notification connector type." }, "GetConnectorTypeSummariesResponse": { "title": "Get Connector Type Summaries Response", "type": "object", "properties": { "connectorTypeSummaries": { "maxItems": 800, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorTypeSummary" }, "description": "The connector type summaries." } }, "description": "Response containing summaries of connector types", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "GetContextualDataIntegrationDefinitionResponse": { "title": "Get contextual data integration definition response", "type": "object", "properties": { "integrationDefinition": { "$ref": "#/components/schemas/IntegrationDefinition" } }, "description": "Response containing the definition of a contextual data integration type." }, "GetContextualDataIntegrationDetailsResponse": { "title": "Get contextual data integration details response", "type": "object", "properties": { "integrationDetail": { "$ref": "#/components/schemas/IntegrationDetails" } }, "description": "Response containing the details of a contextual data integration." }, "GetContextualDataIntegrationsResponse": { "title": "Get contextual data integrations response", "type": "object", "properties": { "integrations": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GetContextualDataIntegrationsResponse.IntegrationWithCounts" }, "description": "The integrations." } }, "description": "Response containing a list of contextual data integrations." }, "GetContextualDataIntegrationsResponse.IntegrationWithCounts": { "title": "Integration with counts", "type": "object", "properties": { "amountIntegrations": { "description": "The amount integrations.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "errors": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of errors." }, "description": "List of errors." }, "integration": { "$ref": "#/components/schemas/Integration" }, "isDeprecated": { "description": "The is deprecated.", "type": "boolean", "x-coralogix-presence": true }, "isNew": { "description": "The is new.", "type": "boolean", "x-coralogix-presence": true }, "upgradeAvailable": { "description": "The upgrade available.", "type": "boolean", "x-coralogix-presence": true } } }, "GetCustomEnrichmentResponse": { "title": "Get Custom Enrichment Response", "required": [ "customEnrichment" ], "type": "object", "properties": { "customEnrichment": { "$ref": "#/components/schemas/CustomEnrichment" } }, "description": "This response data structure is obtained when a custom enrichment is retrieved", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "GetCustomEnrichmentsResponse": { "title": "Get Custom Enrichments Response", "type": "object", "properties": { "customEnrichments": { "maxItems": 30, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CustomEnrichment" }, "description": "The custom enrichments." } }, "description": "This response data structure is obtained when all custom enrichments are retrieved", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "GetCustomEvaluationsResponse": { "type": "object", "properties": { "items": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CustomEvaluation" }, "description": "The custom evaluations in the catalog." } }, "description": "Response containing the custom evaluations in the catalog." }, "GetCustomRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/CustomRole" } }, "description": "Response containing the details of a custom role." }, "GetDashboardBySlugResponse": { "title": "Get dashboard by URL slug response data structure", "required": [ "permissions" ], "type": "object", "properties": { "accessPolicy": { "description": "JSON string with the access policy of this dashboard. Present only when the caller holds `team-dashboards:ReadAccessPolicy` together with `team-dashboards:Read` on this dashboard, or the break-glass `access-policies:ReadAll`.", "examples": [ "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}" ], "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "authorId": { "description": "The author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "authorName": { "description": "The author name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "createdAt": { "description": "Creation timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "createdOriginType": { "$ref": "#/components/schemas/TokenOriginType" }, "dashboard": { "allOf": [ { "$ref": "#/components/schemas/Dashboard" } ], "description": "The dashboard definition. Omitted when the caller lacks `team-dashboards:Read`." }, "isLocked": { "description": "The is locked.", "type": "boolean", "x-coralogix-presence": true }, "lockerAuthorId": { "description": "The locker author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "lockerName": { "description": "The locker name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/DashboardPermissions" } ], "description": "What the caller may do with this dashboard." }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "updatedOriginType": { "$ref": "#/components/schemas/TokenOriginType" }, "updaterAuthorId": { "description": "The updater author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "updaterName": { "description": "The updater name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "This is a response containing the requested dashboard", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "GetDashboardCatalogResponse": { "title": "Get dashboard catalog response data structure.", "type": "object", "properties": { "items": { "maxItems": 100000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DashboardCatalogItem" }, "description": "List of items." } }, "description": "Response containing the dashboard catalog." }, "GetDashboardFolderResponse": { "title": "Get dashboard folder response data structure", "type": "object", "properties": { "folder": { "allOf": [ { "$ref": "#/components/schemas/DashboardFolder" } ], "description": "The folder." } }, "description": "Response containing the details of a dashboard folder.", "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", "required": [ "permissions" ], "type": "object", "properties": { "accessPolicy": { "description": "JSON string with the access policy of this dashboard. Present only when the caller holds `team-dashboards:ReadAccessPolicy` together with `team-dashboards:Read` on this dashboard, or the break-glass `access-policies:ReadAll`.", "examples": [ "{\"version\":\"2025-01-01\",\"default\":{\"permissions\":{\"team-dashboards:Read\":\"grant\",\"team-dashboards:Update\":\"deny\",\"team-dashboards:ReadAccessPolicy\":\"grant\",\"team-dashboards:UpdateAccessPolicy\":\"deny\"}},\"rules\":[]}" ], "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "authorId": { "description": "The author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "authorName": { "description": "The author name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "createdAt": { "description": "Creation timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "createdOriginType": { "$ref": "#/components/schemas/TokenOriginType" }, "dashboard": { "allOf": [ { "$ref": "#/components/schemas/Dashboard" } ], "description": "The dashboard definition. Omitted when the caller lacks `team-dashboards:Read`." }, "isLocked": { "description": "The is locked.", "type": "boolean", "x-coralogix-presence": true }, "lockerAuthorId": { "description": "The locker author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "lockerName": { "description": "The locker name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissions": { "allOf": [ { "$ref": "#/components/schemas/DashboardPermissions" } ], "description": "What the caller may do with this dashboard." }, "resolvedWidgets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Widget" }, "description": "Map of resolved widget references for widgets with references in the dashboard" }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "updatedOriginType": { "$ref": "#/components/schemas/TokenOriginType" }, "updaterAuthorId": { "description": "The updater author id.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "updaterName": { "description": "The updater name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "This is a response containing the requested dashboard", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "GetDataUsageCapabilitiesResponse": { "type": "object", "properties": { "maxFilterValues": { "maximum": 1024, "minimum": 0, "type": "integer", "description": "Maximum number of values accepted by one label filter.", "format": "int64" }, "maxFilters": { "maximum": 16, "minimum": 0, "type": "integer", "description": "Maximum number of label filters accepted in one query.", "format": "int64" }, "maxGroupByLabels": { "maximum": 16, "minimum": 0, "type": "integer", "description": "Maximum number of label keys accepted in a `groupBy` request.", "format": "int64" }, "maxUsageEntriesPerMessage": { "maximum": 1000000, "minimum": 0, "type": "integer", "description": "Maximum number of usage entries the server may include in a single response. `0` means no fixed entry limit is advertised.", "format": "int64" }, "supportedLabels": { "maxItems": 256, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageCapabilityLabel" }, "description": "Supported labels for the public API surface, with descriptions, cardinality hints, and any stable known values." }, "supportedMeasurements": { "maxItems": 32, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageCapabilityMeasurement" }, "description": "Supported measurement kinds and raw units returned by `UsageEntry`." } }, "description": "Capabilities of the public data-usage query surface in v1." }, "GetDefaultPresetSummaryResponse": { "type": "object", "properties": { "presetSummary": { "$ref": "#/components/schemas/PresetSummary" } }, "description": "Response containing a summary of the default notification preset." }, "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.", "default": [] } }, "description": "Response containing a list of deployed extensions." }, "GetDeployedIntegrationResponse": { "title": "Get deployed integration response", "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/DeployedIntegrationInformation" } }, "description": "Response containing details of a deployed integration." }, "GetE2MResponse": { "title": "Get E2M Response", "required": [ "e2m" ], "type": "object", "properties": { "e2m": { "allOf": [ { "$ref": "#/components/schemas/E2M" } ], "description": "The e2m." } }, "description": "This data structure is obtained when retrieving an existing event to metric definition", "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "GetEnrichmentLimitResponse": { "title": "Enrichment Limit", "required": [ "limit", "used" ], "type": "object", "properties": { "limit": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Maximum number of enrichment rules allowed for the account. Defaults to 5.", "format": "int64", "examples": [ 10 ] }, "used": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of enrichment rules currently in use.", "format": "int64", "examples": [ 5 ] } }, "description": "This response data structure represents the enrichments limit", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "GetEnrichmentsResponse": { "title": "Enrichment Collection", "required": [ "enrichments" ], "type": "object", "properties": { "enrichments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "description": "List of enrichments." } }, "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/" } }, "GetEventsStatisticsResponse": { "title": "GetEventsStatisticsResponse", "type": "object", "properties": { "cxEventLabelsFieldStatistics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldStatistics" }, "description": "The cx event labels field statistics." }, "cxEventMetadataFieldStatistics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldStatistics" }, "description": "The cx event metadata field statistics." } } }, "GetGlobalRouterResponse": { "title": "Get Global Router Response", "type": "object", "properties": { "router": { "$ref": "#/components/schemas/GlobalRouter" } }, "description": "Response containing a requested global router", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "GetGroupUsersResponse": { "title": "GetGroupUsersResponse", "type": "object", "properties": { "nextPageToken": { "description": "Token for fetching the next page of results.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "totalCount": { "description": "The total count.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "users": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/rbac.v2.User" }, "description": "List of users." } }, "description": "Response containing the list of all users currently assigned to the requested team group.", "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/" } }, "GetGroupingKeysResponse": { "title": "Get grouping keys response", "required": [ "groupingKeys" ], "type": "object", "properties": { "groupingKeys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of available grouping keys for organizing and filtering cases" }, "description": "List of available grouping keys for organizing and filtering cases", "examples": [ [ "service", "team", "environment", "severity", "source" ] ] } }, "description": "Response containing available grouping keys" }, "GetIncidentByEventIdResponse": { "title": "Get incident by event id response", "required": [ "incident" ], "type": "object", "properties": { "incident": { "allOf": [ { "$ref": "#/components/schemas/Incident" } ], "description": "The requested incident" } }, "description": "Response containing the requested incident" }, "GetIncidentEventsResponse": { "title": "Get incident events response", "type": "object", "properties": { "incidentEvents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentEvent" }, "description": "List of incident events" } }, "description": "Response containing all events associated with the requested incident" }, "GetIncidentResponse": { "title": "Get incident response", "required": [ "incident" ], "type": "object", "properties": { "incident": { "allOf": [ { "$ref": "#/components/schemas/Incident" } ], "description": "The requested incident" } }, "description": "Response containing the requested incident" }, "GetIntegrationDefinitionResponse": { "title": "Get integration definition response", "type": "object", "properties": { "integrationDefinition": { "$ref": "#/components/schemas/IntegrationDefinition" } } }, "GetIntegrationDetailsResponse": { "title": "Get integration details response", "type": "object", "properties": { "integrationDetail": { "$ref": "#/components/schemas/IntegrationDetails" } }, "description": "Response containing the details of an integration definition." }, "GetIntegrationsResponse": { "title": "Get integrations response", "type": "object", "properties": { "integrations": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GetIntegrationsResponse.IntegrationWithCounts" }, "description": "The integrations." } } }, "GetIntegrationsResponse.IntegrationWithCounts": { "title": "Integration with counts", "type": "object", "properties": { "amountIntegrations": { "description": "The amount integrations.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "errors": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of errors." }, "description": "List of errors." }, "integration": { "$ref": "#/components/schemas/Integration" }, "isDeprecated": { "description": "The is deprecated.", "type": "boolean", "x-coralogix-presence": true }, "isNew": { "description": "The is new.", "type": "boolean", "x-coralogix-presence": true }, "upgradeAvailable": { "description": "The upgrade available.", "type": "boolean", "x-coralogix-presence": true } } }, "GetLimitsResponse": { "type": "object", "properties": { "companyId": { "description": "The company id.", "examples": [ "123456" ], "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "labelsLimit": { "maximum": 255, "minimum": 0, "type": "integer", "description": "The labels limit.", "format": "int32" }, "metricsLimit": { "$ref": "#/components/schemas/LimitUsage" }, "permutationsLimit": { "$ref": "#/components/schemas/LimitUsage" } }, "description": "Response containing the events-to-metrics quota limits." }, "GetManagedIntegrationStatusResponse": { "title": "Get managed integration status response", "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." }, "GetOutgoingWebhookResponse": { "title": "Get outgoing webhook response", "required": [ "webhook" ], "type": "object", "properties": { "webhook": { "$ref": "#/components/schemas/OutgoingWebhook" } }, "description": "Response containing the details of an outgoing webhook." }, "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." }, "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/" } }, "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." }, "GetPresetResponse": { "type": "object", "properties": { "preset": { "$ref": "#/components/schemas/Preset" } }, "description": "Response containing the details of a notification preset." }, "GetQuotaAllocationRuleSetResponse": { "title": "Get quota allocation rule set response", "type": "object", "properties": { "ruleSet": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRuleSet" } }, "description": "Response containing quota allocation rule set" }, "GetRetentionsEnabledResponse": { "title": "Get Retentions Enabled Response", "type": "object", "properties": { "enableTags": { "description": "The enable tags.", "type": "boolean", "x-coralogix-presence": true } }, "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": { "required": [ "retentions" ], "type": "object", "properties": { "retentions": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/archive.v1.Retention" }, "description": "The retentions of the team, ordered by `order`. The team has a fixed number of retentions, and a read creates the missing ones with default names." } }, "description": "Response containing the current data retention settings." }, "GetRuleGroupModelMappingRequest.CreateRuleSubgroup": { "type": "object", "properties": { "enabled": { "description": "Whether this resource is enabled.", "type": "boolean", "x-coralogix-presence": true }, "order": { "description": "Sort order.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "rules": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GetRuleGroupModelMappingRequest.CreateRuleSubgroup.CreateRule" }, "description": "List of rules." } } }, "GetRuleGroupModelMappingRequest.CreateRuleSubgroup.CreateRule": { "type": "object", "properties": { "description": { "description": "Human-readable description.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Whether this resource is enabled.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "order": { "description": "Sort order.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "parameters": { "$ref": "#/components/schemas/RuleParameters" }, "sourceField": { "description": "The source field.", "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "GetRuleGroupModelMappingResponse": { "type": "object", "properties": { "ruleDefinition": { "type": "object", "description": "The rule definition." } }, "description": "Response containing the model mapping for a parsing rule group." }, "GetRuleGroupResponse": { "type": "object", "properties": { "ruleGroup": { "$ref": "#/components/schemas/RuleGroup" } }, "description": "Response containing the details of a parsing rule group." }, "GetRumApplicationVersionDataResponse": { "title": "Get RUM application version data response", "type": "object", "properties": { "versionData": { "$ref": "#/components/schemas/RumVersionData" } }, "description": "Response containing RUM application version data." }, "GetSPParametersResponse": { "title": "Get SP Parameters Response", "type": "object", "properties": { "params": { "$ref": "#/components/schemas/SPParameters" } }, "description": "This data structure is obtained as a response to a request 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/" } }, "GetScopesResponse": { "title": "Get Scopes Response", "required": [ "scopes" ], "type": "object", "properties": { "scopes": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.Scope" }, "description": "List of scopes." } }, "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "GetSendDataApiKeysResponse": { "title": "Get Api Key Response", "type": "object", "properties": { "keys": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/KeyInfo" }, "description": "The keys." } }, "description": "This data structure is the response obtained when retrieving an API key.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "GetSloResponse": { "title": "GetSloResponse", "required": [ "slo" ], "type": "object", "properties": { "slo": { "$ref": "#/components/schemas/Slo" } }, "description": "Response containing the details of a specific SLO." }, "GetSloStatusResponse": { "title": "GetSloStatusResponse", "required": [ "computedAt", "effectiveFrom", "effectiveTo", "lowestCompliance", "lowestRemainingErrorBudget", "effectiveWindowCompleteData" ], "type": "object", "properties": { "computedAt": { "description": "Time at which the evaluation was performed, as an RFC 3339 UTC timestamp on a whole-minute instant (suffix `Z`, no fractional seconds).", "format": "date-time", "maxLength": 20, "minLength": 20, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$", "type": "string", "x-coralogix-presence": true }, "effectiveFrom": { "description": "Inclusive lower bound of the evaluation window that was applied, after defaults, as an RFC 3339 UTC whole-minute instant (suffix `Z`).", "format": "date-time", "maxLength": 20, "minLength": 20, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$", "type": "string", "x-coralogix-presence": true }, "effectiveTo": { "description": "Exclusive upper bound of the evaluation window that was applied, after defaults, as an RFC 3339 UTC whole-minute instant (suffix `Z`).", "format": "date-time", "maxLength": 20, "minLength": 20, "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:00Z$", "type": "string", "x-coralogix-presence": true }, "effectiveWindowCompleteData": { "type": "boolean", "description": "When true, recorded source metrics for the evaluated grouping slice fully cover the applied evaluation window between `effectiveFrom` and `effectiveTo`, so `lowestCompliance` and `lowestRemainingErrorBudget` may be treated as final for that window. When false, the evaluation used partial data within that window. Completeness is determined only from `effectiveFrom` and `effectiveTo` (including after request defaults); it is independent of whether the SLO configured rolling time frame has matured since creation or last revision. For example, a short, fully recorded custom window may report true here while permutations in the configured rolling window still have incomplete historical coverage." }, "lowestCompliance": { "maximum": 1, "minimum": 0, "type": "number", "description": "Lowest compliance ratio among atomic permutations that match the evaluated grouping slice for the applied evaluation window, in the range 0-1 (minimum of per-permutation compliance ratios, not compliance from pooled good/total counts). When the slice is a single atomic permutation, this equals that permutation's compliance. When there are no events in the window, the value is 0.", "format": "float" }, "lowestRemainingErrorBudget": { "maximum": 1, "minimum": 0, "type": "number", "description": "Lowest remaining error budget ratio among atomic permutations that match the evaluated grouping slice for the applied evaluation window, in the range 0-1 (minimum of per-permutation remaining error budget ratios). When the slice is a single atomic permutation, this equals that permutation's remaining error budget. When there are no events in the window, the value is 0.", "format": "float" } }, "description": "Lowest compliance and remaining error budget over the atomic permutations that match the requested grouping slice (minimum of each permutation's ratio, not a recomputed ratio from pooled event counts), for the applied evaluation window (`effectiveFrom` inclusive, `effectiveTo` exclusive). Values are normalized ratios in the range 0-1." }, "GetSystemDefaultCaseSettingsResponse": { "title": "Get default case settings response", "required": [ "globalIndicatorSettings" ], "type": "object", "properties": { "caseLifecycle": { "allOf": [ { "$ref": "#/components/schemas/CaseLifecycle" } ], "description": "System-wide default Case lifecycle settings for case settings team configurations" }, "globalIndicatorSettings": { "allOf": [ { "$ref": "#/components/schemas/GlobalIndicatorSettings" } ], "description": "System-wide default settings for case settings team configurations" } }, "description": "Response containing platform-wide default case settings team configuration values." }, "GetSystemDefaultPresetSummaryResponse": { "type": "object", "properties": { "presetSummary": { "$ref": "#/components/schemas/PresetSummary" } }, "description": "Response containing a summary of the system default notification preset." }, "GetTeamGroupByNameResponse": { "title": "GetTeamGroupByNameResponse", "type": "object", "properties": { "group": { "$ref": "#/components/schemas/TeamGroup" } }, "description": "Response containing the complete details of a team group that matches the requested name, including its members, 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", "properties": { "group": { "$ref": "#/components/schemas/TeamGroup" } }, "description": "Response containing the complete details of a requested team group, including its members, assigned roles, and scope configuration.", "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", "properties": { "groups": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TeamGroup" }, "description": "List of groups." }, "nextPageToken": { "description": "Token for fetching the next page of results.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "totalCount": { "description": "The total count.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Response containing a paginated list of team groups.", "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/" } }, "GetTeamMembersApiKeysResponse": { "title": "Get Team Members API Keys Response", "type": "object", "properties": { "keys": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ApiKeySummary" }, "description": "The keys." } }, "description": "This data structure is the response obtained when retrieving team members API keys.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "GetTeamResponse": { "required": [ "teamId", "teamName", "dailyQuota", "retention" ], "type": "object", "properties": { "dailyQuota": { "type": "number", "description": "Daily quota assigned to the team, in quota units per day. The service stores the quota as a 32-bit float, so the value reads back as the nearest 32-bit float: 0.3 reads back as 0.30000001192092896.", "format": "double" }, "retention": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Retention period of the team's data, in days. Set by the service; a request cannot change it.", "format": "int32" }, "teamId": { "allOf": [ { "$ref": "#/components/schemas/v2.TeamId" } ], "description": "Identifier of the team." }, "teamName": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name of the team. Unique in the organization; never empty." } }, "description": "Response containing the requested team." }, "GetTemplateResponse": { "title": "Get template response", "type": "object", "properties": { "templateUrl": { "description": "The template url.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Response containing an integration template." }, "GetTenantConfigResponseV2": { "type": "object", "properties": { "tenantConfig": { "$ref": "#/components/schemas/TenantConfigV2" } }, "description": "Response containing the current metrics tenant configuration." }, "GetUserResponse": { "title": "GetUserResponse", "type": "object", "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/rbac.v2.User" } ], "description": "Complete user details" } }, "description": "Response containing the complete details of the requested user, including account information, status, login modes, and access configuration.", "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/" } }, "GetZeroStateResponse": { "title": "GetZeroStateResponse", "required": [ "zeroState" ], "type": "object", "properties": { "zeroState": { "type": "boolean", "description": "The zero state." } }, "description": "Response with Zero State." }, "GlobalIndicatorSettings": { "title": "Global indicator settings", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/disable this setting. When this is disabled, no alerts will be processed for cases." }, "filteringConditions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IndicatorFilter" }, "description": "Whitelist conditions for the alerts to be processed. Empty list means all alerts are processed. Filtering_condition evaluations will be OR'ed together" } }, "description": "Team-level indicator configuration options for case management, including case lifecycle and event filtering conditions." }, "GlobalRouter": { "title": "Global Router", "required": [ "name" ], "type": "object", "properties": { "createTime": { "description": "The create time. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "maxLength": 5000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description." }, "disabled": { "default": false, "description": "Whether the router is disabled.", "type": "boolean", "x-coralogix-presence": true }, "entityLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The entity labels." }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "deprecated": true, "x-coralogix-presence": true }, "fallback": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RoutingTarget" }, "description": "The fallback destinations to be used if no rule matches. Deprecated: use fallbackTargets. A router cannot set both fallback and fallbackTargets. The server does not keep the order of the targets.", "deprecated": true }, "fallbackTargets": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FallbackTarget" }, "description": "The fallback targets. A router cannot set both fallback and fallbackTargets. The server does not keep the order of the fallback targets." }, "id": { "description": "Unique identifier.", "examples": [ "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name.", "examples": [ "My Router" ] }, "routingLabels": { "$ref": "#/components/schemas/RoutingLabels" }, "rules": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RoutingRule" }, "description": "List of rules." }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true } }, "description": "Defines a set of pre-configured routing rules for directing notifications", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "GoToDashboardTemplateAction": { "type": "object", "properties": { "dashboardId": { "description": "Reference to specific dashboard", "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Go to dashboard template action." }, "GroupByValues": { "type": "object", "oneOf": [ { "required": [ "incidentField" ], "type": "object" }, { "required": [ "contextualLabels" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "incidentField" ], "type": "object" }, { "required": [ "contextualLabels" ], "type": "object" } ] } } ], "properties": { "contextualLabels": { "allOf": [ { "$ref": "#/components/schemas/ContextualLabels" } ], "description": "The contextual labels." }, "incidentField": { "$ref": "#/components/schemas/IncidentFieldOneOf" } } }, "GroupOrigin": { "enum": [ "GROUP_ORIGIN_UNSPECIFIED", "GROUP_ORIGIN_BUILT_IN", "GROUP_ORIGIN_USER_DEFINED" ], "type": "string", "description": "Group origin." }, "GroupType": { "enum": [ "GROUP_TYPE_UNSPECIFIED", "GROUP_TYPE_OPEN", "GROUP_TYPE_CLOSED", "GROUP_TYPE_RESTRICTED" ], "type": "string", "description": "Group type." }, "HallucinationCompletenessConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the HallucinationCompleteness evaluation (no fields)." }, "HallucinationContextAdherenceConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the HallucinationContextAdherence evaluation (no fields)." }, "HallucinationContextRelevanceConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the HallucinationContextRelevance evaluation (no fields)." }, "HallucinationCorrectnessConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the HallucinationCorrectness evaluation (no fields)." }, "HallucinationTaskAdherenceConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the HallucinationTaskAdherence evaluation (no fields)." }, "Heatmap": { "type": "object", "oneOf": [ { "required": [ "preset" ], "type": "object" }, { "required": [ "colorRange" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "preset" ], "type": "object" }, { "required": [ "colorRange" ], "type": "object" } ] } } ], "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "colorAxisMax": { "description": "Optional number indicating the max value for gradient color axis. Automatically calculated from data if not provided.", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "colorAxisMin": { "description": "Optional number indicating the lowest value for gradient color axis. Automatically calculated from data if not provided.", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "colorRange": { "allOf": [ { "$ref": "#/components/schemas/ColorGradientType" } ], "description": "Color configuration for the heatmap" }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "histogramBucketUnit": { "allOf": [ { "$ref": "#/components/schemas/HeatmapHistogramBucketUnit" } ], "description": "Unit used to format histogram bucket boundaries when a heatmap axis represents cumulative histogram buckets", "x-coralogix-presence": true }, "preset": { "$ref": "#/components/schemas/HeatmapColorPreset" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "showNumbers": { "description": "Whether to render numeric values inside the heatmap tiles", "type": "boolean", "x-coralogix-presence": true }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/HeatmapTooltip" } ], "description": "Tooltip settings for the widget" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "valueField": { "$ref": "#/components/schemas/ObservationField" }, "xAxisFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields used as x-axis categories in the heatmap grid." }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis (only applicable when X axis contains timestamp fields)", "x-coralogix-presence": true }, "yAxisFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields used as y-axis categories in the heatmap grid." } }, "description": "Heatmap." }, "HeatmapColorPreset": { "enum": [ "HEATMAP_COLOR_PRESET_UNSPECIFIED", "HEATMAP_COLOR_PRESET_BLUE", "HEATMAP_COLOR_PRESET_GREEN", "HEATMAP_COLOR_PRESET_RED", "HEATMAP_COLOR_PRESET_THRESHOLD", "HEATMAP_COLOR_PRESET_BLUE_REVERSED", "HEATMAP_COLOR_PRESET_GREEN_REVERSED", "HEATMAP_COLOR_PRESET_RED_REVERSED", "HEATMAP_COLOR_PRESET_THRESHOLD_REVERSED" ], "type": "string", "description": "Heatmap color preset." }, "HeatmapHistogramBucketUnit": { "enum": [ "HEATMAP_HISTOGRAM_BUCKET_UNIT_UNSPECIFIED", "HEATMAP_HISTOGRAM_BUCKET_UNIT_NANOSECONDS", "HEATMAP_HISTOGRAM_BUCKET_UNIT_MICROSECONDS", "HEATMAP_HISTOGRAM_BUCKET_UNIT_MILLISECONDS", "HEATMAP_HISTOGRAM_BUCKET_UNIT_SECONDS", "HEATMAP_HISTOGRAM_BUCKET_UNIT_BYTES_IEC", "HEATMAP_HISTOGRAM_BUCKET_UNIT_KIBYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_MIBYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_GIBYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_BYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_KBYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_MBYTES", "HEATMAP_HISTOGRAM_BUCKET_UNIT_GBYTES" ], "type": "string", "description": "Heatmap histogram bucket unit." }, "HeatmapTooltip": { "type": "object", "properties": { "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "Labels to display on the tooltip, should reference fields used in x-axis or y-axis" }, "messageTemplate": { "description": "Custom template for the heatmap tooltip", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Heatmap tooltip." }, "HelmChart": { "title": "Helm chart", "type": "object", "properties": { "commands": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CommandInformation" }, "description": "The commands." }, "guide": { "$ref": "#/components/schemas/IntegrationGuide" }, "template": { "description": "The template.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "Hexagon": { "type": "object", "properties": { "customUnit": { "description": "Custom unit (requires to have unit field set as UNIT_CUSTOM to take effect)", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 2 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "Indicates how to group the legend elements, either by thresholds or by query groups" }, "max": { "description": "A maximum value used in percentage threshold calculation and for visual value representation", "examples": [ 150000 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum value used in percentage threshold calculation and for visual value representation", "examples": [ 0 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/Hexagon.Query" } ], "description": "A query object containing query definition" }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of value thresholds, each with a certain color and an optional name label" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or custom", "examples": [ "17" ] } }, "description": "Hexagon." }, "Hexagon.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "Hexagon.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of observation fields by which to group the results" }, "logsAggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Aggregation function" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A logs variant of the query" }, "Hexagon.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/common.Aggregation" } ], "description": "Aggregation function" }, "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder based", "examples": [ "1" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "Hexagon.Query": { "type": "object", "oneOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metrics" ], "type": "object" }, { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/Hexagon.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/Hexagon.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/Hexagon.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/Hexagon.SpansQuery" } }, "description": "Discriminated union of possible query types for the hexagon widget." }, "Hexagon.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "Lucene query string to search span records" }, "spansAggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Span query aggregation function" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "HexagonBins": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "customUnit": { "description": "Custom unit (requires to have unit field set as UNIT_CUSTOM to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 2 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "Indicates how to group the legend elements, either by thresholds or by query groups" }, "max": { "description": "A maximum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 150000 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 0 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of value thresholds, each with a certain color and an optional name label" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or 'custom'", "examples": [ "3" ] }, "valueField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Hexagon bins." }, "HorizontalBarChart": { "type": "object", "properties": { "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "displayOnBar": { "description": "Specifies where to display the bar value", "type": "boolean", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a bar group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBarChart.Query" } ], "description": "Query object" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortBy": { "allOf": [ { "$ref": "#/components/schemas/SortByType" } ], "description": "Sort type, by name or by value", "examples": [ "1" ] }, "stackDefinition": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBarChart.StackDefinition" } ], "description": "Configuration of stacked bars" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisViewBy": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBarChart.YAxisViewBy" } ], "description": "Specifies how to organize the y-axis view" } }, "description": "Horizontal bar chart." }, "HorizontalBarChart.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which results are grouped" }, "description": "List of field names by which results are grouped" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "HorizontalBarChart.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names to group the query results" }, "description": "List of field names to group the query results" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields to group the results" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "stackedGroupName": { "description": "Field name by which results are stacked in individual group", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Observation field by results are stacked in a group" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "A logs variant of the query" }, "HorizontalBarChart.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/common.Aggregation" } ], "description": "Aggregation function" }, "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder mode", "examples": [ "2" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which metric results are grouped" }, "description": "List of field names by which metric results are grouped" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "HorizontalBarChart.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/HorizontalBarChart.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/HorizontalBarChart.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/HorizontalBarChart.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/HorizontalBarChart.SpansQuery" } }, "description": "Query." }, "HorizontalBarChart.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Span query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields definitions to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search span records" }, "stackedGroupName": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "Field name by which results are stacked in individual group" }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/SpanObservationField" } ], "description": "Observation field definition by which groups are divided into subgroups" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "HorizontalBarChart.StackDefinition": { "type": "object", "properties": { "maxSlicesPerBar": { "description": "How many slices can fit in a single bar", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "stackNameTemplate": { "description": "Custom template name of an individual stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Stack definition." }, "HorizontalBarChart.YAxisViewBy": { "type": "object", "oneOf": [ { "required": [ "category" ], "type": "object" }, { "required": [ "value" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "category" ], "type": "object" }, { "required": [ "value" ], "type": "object" } ] } } ], "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/YAxisViewByCategory" } ], "description": "Y axis scale divided by individual groups" }, "value": { "allOf": [ { "$ref": "#/components/schemas/YAxisViewByValue" } ], "description": "Y axis scale divided into value buckets" } }, "description": "Horizontal bar chart.y axis view by." }, "HorizontalBars": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "displayOnBar": { "description": "Specifies where to display the bar value", "type": "boolean", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "maxSlicesPerBar": { "description": "How many slices can fit in a single bar", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortBy": { "allOf": [ { "$ref": "#/components/schemas/SortByType" } ], "description": "Sort type, by name or by value", "examples": [ "1" ] }, "stackNameTemplate": { "description": "Custom template name of an individual stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "subCategoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The sub category fields." }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "valueField": { "$ref": "#/components/schemas/ObservationField" }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisViewBy": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBars.YAxisViewBy" } ], "description": "Specifies how to organize the y-axis view" } }, "description": "Horizontal bars." }, "HorizontalBars.YAxisViewBy": { "enum": [ "Y_AXIS_VIEW_BY_UNSPECIFIED", "Y_AXIS_VIEW_BY_CATEGORY", "Y_AXIS_VIEW_BY_VALUE" ], "type": "string", "description": "Y axis view by." }, "HorizontalBarsMulti": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "displayOnBar": { "description": "Specifies where to display the bar value", "type": "boolean", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "queryFieldSettings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/HorizontalBarsMulti.QueryFieldSettings" }, "description": "Per-query field settings" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/Visualization.SortOrder" } ], "description": "Sort order for bars - by category or by a specific observation field" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisViewBy": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBarsMulti.YAxisViewBy" } ], "description": "Specifies how to organize the y-axis view" } }, "description": "Visualization configuration for horizontal bars with multiple queries." }, "HorizontalBarsMulti.QueryFieldSettings": { "title": "HorizontalBarsMultiQueryFieldSettings", "required": [ "queryId" ], "type": "object", "properties": { "queryId": { "description": "Reference to the query id from Dynamic.query_display_settings", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Numeric field for this query - each bar gets one value column" } }, "description": "Per-query field settings for horizontal bars multi-query visualization" }, "HorizontalBarsMulti.YAxisViewBy": { "enum": [ "Y_AXIS_VIEW_BY_UNSPECIFIED", "Y_AXIS_VIEW_BY_CATEGORY", "Y_AXIS_VIEW_BY_VALUE" ], "type": "string", "description": "Y axis view by - group category or value." }, "IBMCosTargetSpec": { "title": "IBM COS Target Spec", "required": [ "bucketCrn", "endpoint" ], "type": "object", "properties": { "bucketCrn": { "minLength": 0, "type": "string", "description": "The bucket crn.", "examples": [ "bucket_crn" ] }, "bucketType": { "allOf": [ { "$ref": "#/components/schemas/IbmBucketType" } ], "examples": [ "0" ], "x-coralogix-presence": true }, "endpoint": { "minLength": 0, "type": "string", "description": "Endpoint.", "examples": [ "http://some.endpoint.com:8081" ] }, "serviceCrn": { "description": "The service crn.", "examples": [ "service_crn" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "IDPDetails": { "type": "object", "properties": { "icon": { "minLength": 0, "type": "string", "description": "Icon identifier." }, "name": { "minLength": 0, "type": "string", "description": "Display name." } }, "description": "Idp details." }, "IDPParameters": { "title": "IDP Parameters", "type": "object", "oneOf": [ { "required": [ "metadataUrl" ], "type": "object" }, { "required": [ "metadataContent" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metadataUrl" ], "type": "object" }, { "required": [ "metadataContent" ], "type": "object" } ] } } ], "properties": { "active": { "type": "boolean", "description": "Whether SAML SSO is currently active for this team.", "examples": [ true ] }, "groupNames": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of group names mapped from the identity provider for role-based access.", "examples": [ "group1" ] }, "description": "List of group names mapped from the identity provider for role-based access." }, "metadataContent": { "minLength": 0, "type": "string", "description": "Raw XML content of the identity provider SAML metadata document.", "examples": [ ".okta.com/app/<...>/sso/saml/metadata" ] }, "teamEntityId": { "description": "Coralogix team entity identifier used as the SAML service provider entity ID.", "examples": [ 1234567 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "IbmBucketType": { "enum": [ "IBM_BUCKET_TYPE_UNSPECIFIED", "IBM_BUCKET_TYPE_EXTERNAL", "IBM_BUCKET_TYPE_INTERNAL" ], "type": "string", "description": "Ibm bucket type." }, "IbmConfigV2": { "title": "IBM Bucket Configuration", "type": "object", "properties": { "crn": { "minLength": 0, "type": "string", "description": "The crn.", "examples": [ "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::" ] }, "endpoint": { "minLength": 0, "type": "string", "description": "Endpoint.", "examples": [ "s3.us-south.cloud-object-storage.appdomain.cloud" ] }, "serviceCrn": { "minLength": 0, "type": "string", "description": "The service crn.", "examples": [ "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:12345678-1234-1234-1234-1234567890ab::" ] } }, "externalDocs": { "description": "Find out more about metrics cost optimization", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/" } }, "IbmEventNotificationsConfig": { "title": "IBM event notification configuration", "type": "object", "properties": { "endpointType": { "$ref": "#/components/schemas/EndpointType" }, "eventNotificationsInstanceId": { "description": "The event notifications instance id.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "regionId": { "description": "The region id.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "sourceId": { "description": "The source id.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "sourceName": { "description": "The source name.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Ibm event notifications config." }, "ImpactedEntity": { "title": "Impacted entity", "type": "object", "oneOf": [ { "required": [ "apmService" ], "type": "object" }, { "required": [ "apmDatabase" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "apmService" ], "type": "object" }, { "required": [ "apmDatabase" ], "type": "object" } ] } } ], "properties": { "apmDatabase": { "$ref": "#/components/schemas/ApmDatabaseEntity" }, "apmService": { "$ref": "#/components/schemas/ApmServiceEntity" } }, "description": "Entity affected by a case (e.g., an APM service or database)." }, "ImpactedEntityFilter": { "title": "Impacted entity filter", "type": "object", "oneOf": [ { "required": [ "apmService" ], "type": "object" }, { "required": [ "apmDatabase" ], "type": "object" } ], "properties": { "apmDatabase": { "$ref": "#/components/schemas/ApmDatabaseEntityFilter" }, "apmService": { "$ref": "#/components/schemas/ApmServiceEntityFilter" } }, "description": "Selects cases by an impacted APM entity (service or database)." }, "ImpactedEntityLink": { "title": "Impacted entity link", "type": "object", "properties": { "entity": { "allOf": [ { "$ref": "#/components/schemas/ImpactedEntity" } ], "description": "The impacted entity." }, "url": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Absolute URL to the entity drilldown view." } }, "description": "An impacted entity decorated with a deep link into the relevant product view." }, "InRule": { "title": "In Rule", "required": [ "record", "expr" ], "type": "object", "properties": { "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the recording rule expression. Allows late-arriving data to be ingested before evaluation. An omitted delay stays omitted, and 0 is stored as 0.", "examples": [ 60000 ], "format": "int64", "maximum": 1800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "expr": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The PromQL expression to evaluate. Every evaluation cycle evaluates it at the current time and records the result as a new set of time series with the metric name of `record`." }, "labels": { "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Labels to add or overwrite before storing the result. An omitted map is stored as an empty map." }, "record": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name of the time series to output to. Must be a valid metric name." } }, "description": "A rule within a group that defines a recording rule expression.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "InRuleGroup": { "title": "In Rule Group", "required": [ "name" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "interval": { "default": 60, "description": "How often the rules of the group are evaluated, in seconds. At least 60. An omitted interval is stored as 60, also on an update.", "format": "int64", "maximum": 4294967295, "minimum": 60, "type": "integer", "x-coralogix-presence": true }, "limit": { "default": "0", "description": "Limits the number of series that a rule of the group can produce. 0 means no limit. An omitted limit is stored as 0, also on an update.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name of the group. Unique within the set." }, "rules": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/InRule" }, "description": "List of rules." }, "version": { "description": "Version number.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "A group of recording rules.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "Incident": { "title": "Incident", "required": [ "id", "state", "status", "assignments", "severity", "contextualLabels", "displayLabels", "events", "createdAt", "lastStateUpdateTime", "lastStateUpdateKey", "duration" ], "type": "object", "properties": { "assignments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Assignment" }, "description": "The assignments." }, "closedAt": { "description": "The closed at.", "examples": [ "2024-01-01T00:00:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "contextualLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The contextual labels." }, "createdAt": { "description": "Creation timestamp.", "examples": [ "2024-01-01T00:00:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "examples": [ "incident_description" ], "maxLength": 2000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "displayLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The display labels." }, "duration": { "description": "Duration.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "events": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentEvent" }, "description": "List of events." }, "id": { "description": "Unique identifier.", "examples": [ "3f2504e0-4f89-11d3-9a0c-0305e82c3301" ], "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", "x-coralogix-presence": true }, "isMuted": { "description": "The is muted.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "lastStateUpdateKey": { "description": "The last state update key.", "examples": [ "last_state_update_key" ], "maxLength": 2000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "lastStateUpdateTime": { "description": "The last state update time.", "examples": [ "2024-01-01T00:00:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "metaLabels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" }, "description": "Metadata labels." }, "name": { "description": "Display name.", "examples": [ "incident_name" ], "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "$ref": "#/components/schemas/IncidentSeverity" }, "state": { "allOf": [ { "$ref": "#/components/schemas/IncidentState" } ], "description": "The incident's current internal state, usually derived from the operational events of the incident" }, "status": { "$ref": "#/components/schemas/IncidentStatus" } }, "description": "Incident." }, "IncidentAggregation": { "title": "Incident aggregation", "required": [ "groupBysValue", "aggStateCount", "aggStatusCount", "aggSeverityCount", "aggAssignmentsCount", "firstCreatedAt", "lastClosedAt", "allValuesCount", "listIncidentsId", "lastStateUpdateTime", "aggMetaLabelsCount" ], "type": "object", "properties": { "aggAssignmentsCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentAssignmentCount" }, "description": "The agg assignments count." }, "aggMetaLabelsCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentMetaLabelsCount" }, "description": "The agg meta labels count." }, "aggSeverityCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentSeverityCount" }, "description": "The agg severity count." }, "aggStateCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentStateCount" }, "description": "The agg state count." }, "aggStatusCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentStatusCount" }, "description": "The agg status count." }, "allValuesCount": { "description": "The all values count.", "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "firstCreatedAt": { "description": "The first created at.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "groupBysValue": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GroupByValues" }, "description": "The group bys value." }, "lastClosedAt": { "description": "The last closed at.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "lastStateUpdateTime": { "description": "The last state update time.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "listIncidentsId": { "maxItems": 1000, "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": "The list incidents id." }, "description": "The list incidents id." } } }, "IncidentAssignmentCount": { "title": "Incident assignment count", "required": [ "assignedTo", "count" ], "type": "object", "properties": { "assignedTo": { "$ref": "#/components/schemas/incidents.v1.UserDetails" }, "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } } }, "IncidentEvent": { "title": "Incident event", "required": [ "id", "incidentEventType", "originatorType" ], "type": "object", "allOf": [ { "oneOf": [ { "required": [ "snoozeIndicator" ], "type": "object" }, { "required": [ "assignment" ], "type": "object" }, { "required": [ "unassign" ], "type": "object" }, { "required": [ "upsertState" ], "type": "object" }, { "required": [ "acknowledge" ], "type": "object" }, { "required": [ "close" ], "type": "object" } ] }, { "oneOf": [ { "required": [ "administrativeEvent" ], "type": "object" }, { "required": [ "operationalEvent" ], "type": "object" } ] } ], "properties": { "acknowledge": { "$ref": "#/components/schemas/IncidentEventAcknowledge" }, "administrativeEvent": { "$ref": "#/components/schemas/IncidentEventOriginatorAdministrative" }, "assignment": { "$ref": "#/components/schemas/IncidentEventAssign" }, "close": { "$ref": "#/components/schemas/IncidentEventClose" }, "id": { "description": "The ID of the incident event", "examples": [ "incident_event_id" ], "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "incidentEventType": { "allOf": [ { "$ref": "#/components/schemas/IncidentEventType" } ], "examples": [ "INCIDENT_EVENT_TYPE_ACKNOWLEDGE" ] }, "operationalEvent": { "$ref": "#/components/schemas/IncidentEventOriginatorOperational" }, "originatorType": { "allOf": [ { "$ref": "#/components/schemas/OriginatorType" } ], "examples": [ "ORIGINATOR_TYPE_OPERATIONAL" ] }, "snoozeIndicator": { "$ref": "#/components/schemas/IncidentEventSnoozeIndicator" }, "unassign": { "$ref": "#/components/schemas/IncidentEventUnassign" }, "upsertState": { "$ref": "#/components/schemas/IncidentEventUpsertState" } }, "description": "Incident event." }, "IncidentEventAcknowledge": { "type": "object", "properties": { "acknowledgedBy": { "$ref": "#/components/schemas/incidents.v1.UserDetails" } }, "description": "Incident event acknowledge." }, "IncidentEventAlertType": { "enum": [ "INCIDENT_EVENT_ALERT_TYPE_STANDARD_OR_UNSPECIFIED", "INCIDENT_EVENT_ALERT_TYPE_METRIC", "INCIDENT_EVENT_ALERT_TYPE_NEW_VALUE", "INCIDENT_EVENT_ALERT_TYPE_RATIO", "INCIDENT_EVENT_ALERT_TYPE_TIME_RELATIVE", "INCIDENT_EVENT_ALERT_TYPE_UNIQUE_COUNT", "INCIDENT_EVENT_ALERT_TYPE_TRACING", "INCIDENT_EVENT_ALERT_TYPE_FLOW", "INCIDENT_EVENT_ALERT_TYPE_SLO" ], "type": "string", "description": "Incident event alert type." }, "IncidentEventAssign": { "title": "Incident event assignment details", "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/Assignment" } }, "description": "Incident event assign." }, "IncidentEventClose": { "type": "object", "properties": { "closedBy": { "$ref": "#/components/schemas/incidents.v1.UserDetails" } }, "description": "Incident event close." }, "IncidentEventExtended": { "title": "Extended incident event", "required": [ "cxEventKey", "incidentEvent", "cxEventTimestamp" ], "type": "object", "properties": { "cxEventKey": { "description": "The cx event key.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "cxEventTimestamp": { "description": "The cx event timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "incidentEvent": { "$ref": "#/components/schemas/IncidentEvent" }, "incidentEventExtendedMetadata": { "$ref": "#/components/schemas/IncidentEventExtendedMetadata" } } }, "IncidentEventExtendedMetadata": { "type": "object", "properties": { "alertGroupByFields": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The alert group by fields." }, "description": "The alert group by fields." }, "alertId": { "description": "Unique identifier of the alert.", "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "alertLabels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" }, "description": "The alert labels." }, "alertName": { "description": "The alert name.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "alertType": { "$ref": "#/components/schemas/IncidentEventAlertType" }, "incidentPermutation": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The incident permutation." }, "incidentSeverity": { "$ref": "#/components/schemas/IncidentSeverity" }, "incidentState": { "$ref": "#/components/schemas/IncidentState" }, "incidentStatus": { "$ref": "#/components/schemas/IncidentStatus" }, "isMuted": { "description": "The is muted.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Incident event extended metadata." }, "IncidentEventOrderByFieldType": { "enum": [ "INCIDENT_EVENT_ORDER_BY_FIELD_TYPE_TIMESTAMP_OR_UNSPECIFIED" ], "type": "string", "description": "Incident event order by field type." }, "IncidentEventOriginatorAdministrative": { "type": "object", "properties": { "userId": { "description": "The user id.", "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Incident event originator administrative." }, "IncidentEventOriginatorOperational": { "type": "object", "properties": { "systemName": { "description": "The system name.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Incident event originator operational." }, "IncidentEventSnoozeIndicator": { "title": "Incident event snooze indicator", "type": "object", "properties": { "durationMinutes": { "description": "Duration of the snooze in minutes.", "format": "int32", "maximum": 525960, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "startTime": { "description": "Start time.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "userId": { "description": "The user id.", "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Incident event snooze indicator." }, "IncidentEventType": { "enum": [ "INCIDENT_EVENT_TYPE_UNSPECIFIED", "INCIDENT_EVENT_TYPE_UPSERT_STATE", "INCIDENT_EVENT_TYPE_OPEN", "INCIDENT_EVENT_TYPE_CLOSE", "INCIDENT_EVENT_TYPE_SNOOZE_INDICATOR", "INCIDENT_EVENT_TYPE_ASSIGN", "INCIDENT_EVENT_TYPE_UNASSIGN", "INCIDENT_EVENT_TYPE_ACKNOWLEDGE" ], "type": "string", "description": "Incident event type." }, "IncidentEventUnassign": { "type": "object", "additionalProperties": false, "description": "Incident event unassign." }, "IncidentEventUpsertState": { "title": "Incident event upsert state", "required": [ "stateType", "payload" ], "type": "object", "properties": { "isMuted": { "description": "The is muted.", "type": "boolean", "x-coralogix-presence": true }, "payload": { "$ref": "#/components/schemas/UpsertIncidentStatePayload" }, "stateType": { "$ref": "#/components/schemas/UpsertIncidentStateType" } }, "description": "Incident event upsert state." }, "IncidentFieldOneOf": { "type": "object", "oneOf": [ { "required": [ "id" ], "type": "object" }, { "required": [ "severity" ], "type": "object" }, { "required": [ "name" ], "type": "object" }, { "required": [ "createdAt" ], "type": "object" }, { "required": [ "closedAt" ], "type": "object" }, { "required": [ "state" ], "type": "object" }, { "required": [ "status" ], "type": "object" }, { "required": [ "lastStateUpdateTime" ], "type": "object" }, { "required": [ "applicationName" ], "type": "object" }, { "required": [ "subsystemName" ], "type": "object" }, { "required": [ "duration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "id" ], "type": "object" }, { "required": [ "severity" ], "type": "object" }, { "required": [ "name" ], "type": "object" }, { "required": [ "createdAt" ], "type": "object" }, { "required": [ "closedAt" ], "type": "object" }, { "required": [ "state" ], "type": "object" }, { "required": [ "status" ], "type": "object" }, { "required": [ "lastStateUpdateTime" ], "type": "object" }, { "required": [ "applicationName" ], "type": "object" }, { "required": [ "subsystemName" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ] } } ], "properties": { "applicationName": { "description": "Application associated with the incident.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "closedAt": { "description": "Timestamp when the incident was closed.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "createdAt": { "description": "Timestamp when the incident was created.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "duration": { "description": "Duration.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier of the incident.", "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", "x-coralogix-presence": true }, "lastStateUpdateTime": { "description": "Timestamp of the most recent state change.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name of the incident.", "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "allOf": [ { "$ref": "#/components/schemas/IncidentSeverity" } ], "description": "Severity level of the incident." }, "state": { "allOf": [ { "$ref": "#/components/schemas/IncidentState" } ], "description": "Current internal state of the incident." }, "status": { "allOf": [ { "$ref": "#/components/schemas/IncidentStatus" } ], "description": "Current status of the incident." }, "subsystemName": { "description": "Subsystem associated with the incident.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Incident field one of." }, "IncidentFields": { "enum": [ "INCIDENTS_FIELDS_UNSPECIFIED", "INCIDENTS_FIELDS_ID", "INCIDENTS_FIELDS_SEVERITY", "INCIDENTS_FIELDS_NAME", "INCIDENTS_FIELDS_CREATED_TIME", "INCIDENTS_FIELDS_CLOSED_TIME", "INCIDENTS_FIELDS_STATE", "INCIDENTS_FIELDS_STATUS", "INCIDENTS_FIELDS_LAST_STATE_UPDATE_TIME", "INCIDENTS_FIELDS_APPLICATION_NAME", "INCIDENTS_FIELDS_SUBSYSTEM_NAME", "INCIDENTS_FIELDS_DURATION" ], "type": "string", "description": "Incident fields." }, "IncidentMetaLabelsCount": { "title": "Incident meta labels count", "required": [ "metaLabel", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "metaLabel": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" } } }, "IncidentMetaLabelsWithCount": { "title": "Incident meta labels with count", "required": [ "metaLabel", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "metaLabel": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" } } }, "IncidentQueryFilter": { "title": "Incident query filter", "type": "object", "properties": { "applicationName": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Filter by application names" }, "description": "Filter by application names" }, "assignee": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Filter by assignee" }, "description": "Filter by assignee" }, "contextualLabels": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValues" }, "description": "Filter by contextual labels" }, "createdAtRange": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "Filters all incidents created at the given time range" }, "displayLabels": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValues" }, "description": "Filter by display labels" }, "endTime": { "deprecated": true, "description": "Filters all incidents that were open in the given timeframe end time (deprecated, use incident_open_range instead)", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "incidentDurationRange": { "allOf": [ { "$ref": "#/components/schemas/v1.TimeRange" } ], "description": "Filters all active) incidents with the given duration range" }, "isMuted": { "description": "Indicates if the incident is muted", "type": "boolean", "x-coralogix-presence": true }, "metaLabels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" }, "description": "Filters all incidents with the given meta labels" }, "metaLabelsOp": { "allOf": [ { "$ref": "#/components/schemas/v1.FilterOperator" } ], "description": "The operator for the meta labels filter" }, "searchQuery": { "allOf": [ { "$ref": "#/components/schemas/IncidentSearchQuery" } ], "description": "Search query for incidents" }, "severity": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentSeverity" }, "description": "Filter by incident severity" }, "startTime": { "deprecated": true, "description": "Filters all incidents that were open in the given timeframe start time (deprecated, use incident_open_range instead)", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "state": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentState" }, "description": "Filter by incident state" }, "status": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "description": "Filter by incident status" }, "subsystemName": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Filter by subsystem names" }, "description": "Filter by subsystem names" } }, "description": "Filter configuration for incidents" }, "IncidentQueryFiltersValues": { "title": "Incident query filter values", "required": [ "assigneeWithCount", "statusWithCount", "stateWithCount", "severityWithCount", "contextualLabels", "displayLabels", "metaLabelsWithCount", "metaLabelsOp" ], "type": "object", "properties": { "assigneeWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AssigneeWithCount" }, "description": "The assignee with count." }, "contextualLabels": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContextualLabelValuesWithCount" }, "description": "The contextual labels." }, "displayLabels": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DisplayLabelValuesWithCount" }, "description": "The display labels." }, "metaLabelsOp": { "$ref": "#/components/schemas/v1.FilterOperator" }, "metaLabelsWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentMetaLabelsWithCount" }, "description": "The meta labels with count." }, "severityWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentSeverityWithCount" }, "description": "The severity with count." }, "stateWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentStateWithCount" }, "description": "The state with count." }, "statusWithCount": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentStatusWithCount" }, "description": "The status with count." } }, "description": "Incident query filters values." }, "IncidentSearchQuery": { "title": "Incident search query", "required": [ "query" ], "type": "object", "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", "x-coralogix-presence": true }, "incidentField": { "allOf": [ { "$ref": "#/components/schemas/IncidentFields" } ], "description": "The field to search in", "examples": [ "INCIDENTS_FIELDS_STATUS" ] }, "query": { "description": "The search query", "examples": [ "error" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Incident search query." }, "IncidentSeverity": { "enum": [ "INCIDENT_SEVERITY_UNSPECIFIED", "INCIDENT_SEVERITY_INFO", "INCIDENT_SEVERITY_WARNING", "INCIDENT_SEVERITY_ERROR", "INCIDENT_SEVERITY_CRITICAL", "INCIDENT_SEVERITY_LOW" ], "type": "string", "description": "Incident severity." }, "IncidentSeverityCount": { "title": "Incident severity count", "required": [ "severity", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "severity": { "$ref": "#/components/schemas/IncidentSeverity" } } }, "IncidentSeverityWithCount": { "title": "Incident severity with count", "required": [ "severity", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "severity": { "$ref": "#/components/schemas/IncidentSeverity" } } }, "IncidentState": { "enum": [ "INCIDENT_STATE_UNSPECIFIED", "INCIDENT_STATE_TRIGGERED", "INCIDENT_STATE_RESOLVED" ], "type": "string", "description": "Incident state." }, "IncidentStateCount": { "title": "Incident state count", "required": [ "state", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "state": { "$ref": "#/components/schemas/IncidentState" } } }, "IncidentStateWithCount": { "title": "Incident state with count", "required": [ "state", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/IncidentState" } ], "description": "The state." } } }, "IncidentStatus": { "enum": [ "INCIDENT_STATUS_UNSPECIFIED", "INCIDENT_STATUS_TRIGGERED", "INCIDENT_STATUS_ACKNOWLEDGED", "INCIDENT_STATUS_RESOLVED" ], "type": "string", "description": "Incident status." }, "IncidentStatusCount": { "title": "Incident status count", "required": [ "status", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "status": { "$ref": "#/components/schemas/IncidentStatus" } } }, "IncidentStatusWithCount": { "title": "Incident status with count", "required": [ "status", "count" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 10 ], "format": "int32", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/IncidentStatus" } ], "examples": [ "incident_status" ] } } }, "IndicatorFilter": { "title": "Indicator filter", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable/disable this filter" }, "entityLabels": { "allOf": [ { "$ref": "#/components/schemas/EntityLabelFilter" } ], "description": "Selected entity labels for filtering" }, "priorities": { "allOf": [ { "$ref": "#/components/schemas/IndicatorPriorityFilter" } ], "description": "Selected priorities for filtering" } }, "description": "Object for filtering signals to be processed by the cases pipeline. The filters will be AND'ed together." }, "IndicatorPriority": { "title": "Indicator priority", "enum": [ "INDICATOR_PRIORITY_UNSPECIFIED", "INDICATOR_PRIORITY_P1", "INDICATOR_PRIORITY_P2", "INDICATOR_PRIORITY_P3", "INDICATOR_PRIORITY_P4", "INDICATOR_PRIORITY_P5" ], "type": "string", "description": "Priority of an alert indicator at trigger time." }, "IndicatorPriorityFilter": { "title": "All or IndicatorPriority list", "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/All" }, "values": { "$ref": "#/components/schemas/IndicatorPriorityFilter.Values" } }, "description": "Select all priorities or a specific list of IndicatorPriority values." }, "IndicatorPriorityFilter.Values": { "type": "object", "properties": { "items": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IndicatorPriority" }, "description": "List of IndicatorPriorities to filter to. Passing empty list here means no alerts will be processed." } }, "description": "Entity label filter.values." }, "IndicatorState": { "title": "Indicator state", "enum": [ "INDICATOR_STATE_UNSPECIFIED", "INDICATOR_STATE_TRIGGERED", "INDICATOR_STATE_RESOLVED", "INDICATOR_STATE_NO_DATA" ], "type": "string", "description": "Current lifecycle state of an alert indicator." }, "IndicatorType": { "enum": [ "INDICATOR_TYPE_UNSPECIFIED", "INDICATOR_TYPE_ALERT", "INDICATOR_TYPE_PROMETHEUS_ALERTMANAGER", "INDICATOR_TYPE_ERROR_TRACKING" ], "type": "string" }, "InputType": { "enum": [ "API_KEY", "TEXT", "LIST_TEXT", "MULTIPLE_SELECTION", "BOOLEAN", "SELECT", "JSON", "NUMBER", "SENSITIVE_DATA", "JSON_OBJECT_ARRAY", "AWS_REGION_SELECT", "AWS_REGION_MULTISELECT", "AWS_CLOUDWATCH_NAMESPACE_LIST" ], "type": "string", "description": "Input type." }, "Integration": { "title": "Integration", "type": "object", "properties": { "darkIcon": { "description": "The dark icon.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "featureFlag": { "description": "The feature flag.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "icon": { "description": "Icon identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationType": { "$ref": "#/components/schemas/v1.IntegrationType" }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "revisions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.RevisionSummary" }, "description": "The revisions." }, "tags": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of tags." }, "description": "List of tags." }, "versions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The versions." }, "description": "The versions." } } }, "IntegrationDefinition": { "title": "Integration definition", "type": "object", "properties": { "featureFlag": { "description": "The feature flag.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationType": { "$ref": "#/components/schemas/v1.IntegrationType" }, "key": { "description": "The key.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "revisions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IntegrationRevision" }, "description": "The revisions." } } }, "IntegrationDetail": { "title": "Integration detail", "type": "object", "properties": { "link": { "description": "Link.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "IntegrationDetails": { "title": "Integration details", "type": "object", "oneOf": [ { "required": [ "local" ], "type": "object" }, { "required": [ "external" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "local" ], "type": "object" }, { "required": [ "external" ], "type": "object" } ] } } ], "properties": { "default": { "$ref": "#/components/schemas/DefaultIntegrationDetails" }, "docs": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IntegrationDoc" }, "description": "Documentation links associated with this integration." }, "extensions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v1.Extension" }, "description": "Extensions bundled with this integration for pre-built dashboards and alerts." }, "external": { "$ref": "#/components/schemas/ExternalUrl" }, "integration": { "$ref": "#/components/schemas/Integration" }, "local": { "$ref": "#/components/schemas/LocalChangelog" } } }, "IntegrationDoc": { "title": "Integration doc", "type": "object", "properties": { "link": { "description": "Link.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "IntegrationGuide": { "title": "Integration guide", "type": "object", "properties": { "installationRequirements": { "description": "The installation requirements.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "introduction": { "description": "The introduction.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Integration guide." }, "IntegrationMetadata": { "title": "Integration metadata", "required": [ "integrationKey", "version", "integrationParameters" ], "type": "object", "properties": { "integrationKey": { "description": "The integration key. Must not be empty.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationParameters": { "$ref": "#/components/schemas/GenericIntegrationParameters" }, "version": { "description": "Version number. Must not be empty.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "This data structure represents the metadata of an integration. Parameter names are case sensitive." }, "IntegrationRevision": { "title": "Integration revision", "type": "object", "oneOf": [ { "required": [ "cloudFormation" ], "type": "object" }, { "required": [ "managedService" ], "type": "object" }, { "required": [ "helmChart" ], "type": "object" }, { "required": [ "azureArmTemplate" ], "type": "object" }, { "required": [ "rum" ], "type": "object" }, { "required": [ "terraform" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "cloudFormation" ], "type": "object" }, { "required": [ "managedService" ], "type": "object" }, { "required": [ "helmChart" ], "type": "object" }, { "required": [ "azureArmTemplate" ], "type": "object" }, { "required": [ "rum" ], "type": "object" }, { "required": [ "terraform" ], "type": "object" } ] } } ], "properties": { "azureArmTemplate": { "$ref": "#/components/schemas/AzureArmTemplate" }, "cloudFormation": { "$ref": "#/components/schemas/CloudFormationTemplate" }, "featureFlag": { "description": "The feature flag.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "fields": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FieldInformation" }, "description": "Configuration fields that users must fill in to deploy this integration revision." }, "groups": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IntegrationRevision.Group" }, "description": "UI groups used to organize configuration fields into logical sections." }, "helmChart": { "$ref": "#/components/schemas/HelmChart" }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "managedService": { "$ref": "#/components/schemas/ManagedService" }, "revisionDeploymentSupported": { "type": "boolean", "description": "Whether this revision supports automated deployment through the Coralogix platform." }, "rum": { "$ref": "#/components/schemas/Rum" }, "terraform": { "$ref": "#/components/schemas/Terraform" }, "upgradeInstructionsMd": { "description": "Markdown-formatted upgrade instructions shown when upgrading from a previous revision.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "IntegrationRevision.Group": { "title": "Group", "type": "object", "properties": { "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "IntegrationRevision.SingleNumericValue": { "title": "Single numeric value", "type": "object", "properties": { "defaultValue": { "description": "The default value.", "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Single numeric value." }, "IntegrationStatus": { "title": "Integration status", "type": "object", "properties": { "connectionStatus": { "$ref": "#/components/schemas/ConnectionStatus" }, "details": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of details." }, "messages": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The messages." }, "description": "The messages." } } }, "InternalSectionOptions": { "type": "object", "additionalProperties": false, "description": "Internal section options." }, "Interpretation": { "enum": [ "INTERPRETATION_UNSPECIFIED", "INTERPRETATION_RAW_DATA_TABLE", "INTERPRETATION_TREND_OVER_TIME_LINE", "INTERPRETATION_SINGLE_VALUE_KPI", "INTERPRETATION_MULTI_VALUE_KPI", "INTERPRETATION_CATEGORICAL_ANALYSIS_VERTICAL_BARS", "INTERPRETATION_SINGLE_VALUE_KPI_STAT", "INTERPRETATION_SINGLE_VALUE_KPI_GAUGE", "INTERPRETATION_MULTI_VALUE_KPI_STAT", "INTERPRETATION_MULTI_VALUE_KPI_GAUGE", "INTERPRETATION_MULTI_VALUE_KPI_HEXAGON_BINS", "INTERPRETATION_CATEGORICAL_ANALYSIS_PIE_CHART", "INTERPRETATION_CATEGORICAL_ANALYSIS_HORIZONTAL_BARS", "INTERPRETATION_SINGLE_VALUE_KPI_STAT_CARD", "INTERPRETATION_MULTI_VALUE_KPI_STAT_CARD" ], "type": "string", "description": "Interpretation." }, "IntervalResolution": { "title": "IntervalResolution", "type": "object", "oneOf": [ { "required": [ "auto" ], "type": "object" }, { "required": [ "manual" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "auto" ], "type": "object" }, { "required": [ "manual" ], "type": "object" } ] } } ], "properties": { "auto": { "$ref": "#/components/schemas/AutoIntervalResolution" }, "manual": { "$ref": "#/components/schemas/ManualIntervalResolution" }, "useAdvancedLimit": { "description": "Whether the max. data points and min. interval fields are user-editable. When true, users can modify these constraint fields; when false or unset, they are read-only.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Configuration for time bucket/interval resolution in time-series widgets. Supports automatic calculation based on widget width and time range, or manual interval specification." }, "IntervalValue": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/StringValueLabel" } ], "description": "The value." } }, "description": "Interval value." }, "IpAccess": { "title": "IP Access", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether this IP access entry is enabled.", "examples": [ true ] }, "ipRange": { "minLength": 0, "type": "string", "description": "The IP range in CIDR notation.", "examples": [ "192.168.0.1/24" ] }, "name": { "minLength": 0, "type": "string", "description": "The name of the IP access entry.", "examples": [ "Office Network" ] } }, "description": "Represents a single IP access entry.", "externalDocs": { "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/" } }, "Issue": { "type": "object", "properties": { "location": { "description": "Location of the issue within the dashboard as an RFC 6901 JSON Pointer (e.g. \"/sections/0/rows/1/widgets/2\"). Empty or omitted for root-level issues.", "maxLength": 512, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "message": { "description": "Human-readable description of the issue", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severity": { "allOf": [ { "$ref": "#/components/schemas/IssueSeverity" } ], "description": "Severity of the issue" } } }, "IssueSeverity": { "enum": [ "SEVERITY_UNSPECIFIED", "SEVERITY_ERROR", "SEVERITY_WARNING" ], "type": "string", "description": "Severity of a validation issue." }, "ItemCounts": { "title": "Item counts", "type": "object", "properties": { "actions": { "default": 0, "description": "List of actions.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "alerts": { "default": 0, "description": "List of alerts.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "customDashboards": { "default": 0, "description": "The custom dashboards.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "enrichments": { "default": 0, "description": "List of enrichments.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "eventsToMetrics": { "default": 0, "description": "The events to metrics.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "grafanaDashboards": { "default": 0, "description": "The grafana dashboards.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "kibanaDashboards": { "default": 0, "description": "The kibana dashboards.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "metricsRuleGroup": { "default": 0, "description": "The metrics rule group.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "parsingRules": { "default": 0, "description": "The parsing rules.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "savedViews": { "default": 0, "description": "The saved views.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Item counts." }, "JiraConfig": { "title": "Jira configuration", "required": [ "apiToken", "email", "projectKey" ], "type": "object", "properties": { "apiToken": { "description": "API token. Required on Create and Update. Treat any value returned by Get as a secret.", "examples": [ "jira_api_token" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "email": { "description": "Email address.", "examples": [ "jira_email" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "projectKey": { "description": "The project key.", "examples": [ "jira_project_key" ], "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Jira config." }, "JsonExtractParameters": { "required": [ "rule" ], "type": "object", "properties": { "destinationFieldText": { "description": "The destination path in the log text. Required when `destinationFieldType` is `DESTINATION_FIELD_TEXT`: it must be `text` or start with `text.`.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "destinationFieldType": { "$ref": "#/components/schemas/DestinationField" }, "rule": { "description": "The JSON key whose value is copied. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Json extract parameters. Copies the value of a JSON key into a log field." }, "JsonParseParameters": { "required": [ "destinationField", "deleteSource", "overrideDest" ], "type": "object", "properties": { "deleteSource": { "description": "Whether the source field is removed.", "type": "boolean", "x-coralogix-presence": true }, "destinationField": { "description": "The field that receives the result. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "escapedValue": { "description": "Ignored. The service always parses the value as escaped JSON and never returns this field.", "type": "boolean", "x-coralogix-presence": true }, "overrideDest": { "description": "Whether the result replaces a value that the destination field already has.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Json parse parameters. Parses the JSON string in the source field into an object in the destination field." }, "JsonStringifyParameters": { "required": [ "destinationField", "deleteSource" ], "type": "object", "properties": { "deleteSource": { "description": "Whether the source field is removed.", "type": "boolean", "x-coralogix-presence": true }, "destinationField": { "description": "The field that receives the result. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Json stringify parameters. Writes the source field as a JSON string to the destination field." }, "KPIBreachedCaseEvent": { "title": "KPI breached event", "type": "object", "properties": { "kpiType": { "allOf": [ { "$ref": "#/components/schemas/KPIType" } ], "description": "Type of KPI that was breached", "examples": [ "KPI_TYPE_TIME_TO_ACKNOWLEDGE" ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Case priority at the time of the breach", "examples": [ "CASE_PRIORITY_P2" ] }, "threshold": { "description": "Duration after which the KPI threshold was set to breach", "examples": [ "300s" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Kpi breached case event." }, "KPIBreaches": { "title": "KPI breaches", "required": [ "breachedKpis" ], "type": "object", "properties": { "breachedKpis": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/BreachedKPI" }, "description": "List of breached KPIs for the case", "examples": [ [ { "kpi_type": "KPI_TYPE_TIME_TO_ACKNOWLEDGE", "case_priority": "CASE_PRIORITY_P1", "resolution_breached_at": "2025-09-22T11:00:00.000Z" } ] ] } }, "description": "Current or final KPI breach timestamps for the case. A value is present only when the KPI has been breached." }, "KPIFilter": { "enum": [ "KPI_FILTER_UNSPECIFIED", "KPI_FILTER_TIME_TO_ACKNOWLEDGE_BREACHED", "KPI_FILTER_TIME_TO_RESOLVE_BREACHED", "KPI_FILTER_NOT_BREACHED", "KPI_FILTER_TIME_TO_UPDATE_BREACHED" ], "type": "string" }, "KPIPriority": { "title": "KPI priority", "enum": [ "KPI_PRIORITY_UNSPECIFIED", "KPI_PRIORITY_P1", "KPI_PRIORITY_P2", "KPI_PRIORITY_P3", "KPI_PRIORITY_P4", "KPI_PRIORITY_P5" ], "type": "string", "description": "Case priority level used when evaluating KPIs." }, "KPISettings": { "title": "KPI threshold entry", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable or disable this threshold entry.", "examples": [ true ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Case priority level for which this threshold applies.", "examples": [ "P1" ] }, "threshold": { "description": "Elapsed time after which the KPI is considered breached.", "examples": [ "300s" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/KPIType" } ], "description": "Type of KPI this threshold applies to (acknowledgement or resolution).", "examples": [ "KPI_TYPE_ACKNOWLEDGEMENT" ] } }, "description": "Single KPI breach threshold for a specific case priority." }, "KPIType": { "enum": [ "KPI_TYPE_UNSPECIFIED", "KPI_TYPE_TIME_TO_ACKNOWLEDGE", "KPI_TYPE_TIME_TO_RESOLVE", "KPI_TYPE_TIME_TO_UPDATE" ], "type": "string", "description": "Kpi type." }, "KeyInfo": { "title": "Key Info", "type": "object", "properties": { "accessPolicy": { "description": "JSON string representing the access policy for this API key. Defines granular permissions for users and groups.", "examples": [ "{\"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\":[]}" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "active": { "type": "boolean", "description": "Whether this resource is active.", "examples": [ true ] }, "hashed": { "type": "boolean", "description": "Whether the value is stored as a one-way hash.", "examples": [ true ] }, "id": { "minLength": 0, "type": "string", "description": "Unique identifier." }, "keyPermissions": { "$ref": "#/components/schemas/KeyInfo.KeyPermissions" }, "name": { "minLength": 0, "type": "string", "description": "Display name.", "examples": [ "my_api_key" ] }, "owner": { "allOf": [ { "$ref": "#/components/schemas/Owner" } ], "examples": [ "a_user_id" ] }, "value": { "description": "The value.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "KeyInfo.KeyPermissions": { "title": "Key Permissions", "type": "object", "properties": { "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Permissions." }, "description": "Permissions." }, "presets": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PresetInfo" }, "description": "Presets." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "LabelFilterType": { "title": "Label filter type", "type": "object", "properties": { "operation": { "allOf": [ { "$ref": "#/components/schemas/LogFilterOperationType" } ], "description": "The operation to perform on the label value", "examples": [ "LOG_FILTER_OPERATION_TYPE_INCLUDES" ] }, "value": { "description": "The value of the label to filter by", "examples": [ "my-app" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Label filter type for log entries" }, "LabelFilters": { "title": "Label filters", "type": "object", "properties": { "applicationName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LabelFilterType" }, "description": "The application name." }, "severities": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LogSeverity" }, "description": "The severities." }, "subsystemName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LabelFilterType" }, "description": "The subsystem name." } }, "description": "Filters for application name, subsystem name, and log severities" }, "LabelsFilter": { "title": "Label filter configuration", "required": [ "metaLabels" ], "type": "object", "properties": { "metaLabels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/incidents.v1.MetaLabel" }, "description": "The meta labels of the incident" }, "operator": { "allOf": [ { "$ref": "#/components/schemas/v1.FilterOperator" } ], "description": "The operator for the labels filter" } }, "description": "Filter configuration for incident events based on meta labels and their combination operator." }, "LabelsPermutationsCardinalityDay": { "type": "object", "properties": { "day": { "maxLength": 10, "minLength": 10, "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "The day, formatted as YYYY-MM-DD." }, "permutations": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of label permutations for this day.", "format": "int32" } } }, "Language": { "enum": [ "UNKNOWN", "BASH", "JAVASCRIPT" ], "type": "string", "description": "Language." }, "LanguageMismatchConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the LanguageMismatch evaluation (no fields)." }, "Last": { "type": "object", "additionalProperties": false, "description": "Last." }, "Layout": { "type": "object", "properties": { "sections": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Section" }, "description": "The list of sections in the dashboard" } }, "description": "Layout." }, "Legend": { "type": "object", "properties": { "columns": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LegendColumn" }, "description": "List of columns to display in legend", "examples": [ [ "LEGEND_COLUMN_MIN", "LEGEND_COLUMN_MAX", "LEGEND_COLUMN_NAME" ] ] }, "groupByQuery": { "description": "In case of multiple queries, whether legend items should be grouped by their respective queries", "type": "boolean", "x-coralogix-presence": true }, "isVisible": { "description": "Is the legend visible in the widget", "type": "boolean", "x-coralogix-presence": true }, "placement": { "allOf": [ { "$ref": "#/components/schemas/LegendPlacement" } ], "description": "Location of the legend in the widget" } }, "description": "Legend." }, "LegendBy": { "enum": [ "LEGEND_BY_UNSPECIFIED", "LEGEND_BY_THRESHOLDS", "LEGEND_BY_GROUPS" ], "type": "string", "description": "Legend by." }, "LegendColumn": { "enum": [ "LEGEND_COLUMN_UNSPECIFIED", "LEGEND_COLUMN_MIN", "LEGEND_COLUMN_MAX", "LEGEND_COLUMN_SUM", "LEGEND_COLUMN_AVG", "LEGEND_COLUMN_LAST", "LEGEND_COLUMN_NAME", "LEGEND_COLUMN_SIMPLE_VALUE" ], "type": "string" }, "LegendPlacement": { "enum": [ "LEGEND_PLACEMENT_UNSPECIFIED", "LEGEND_PLACEMENT_AUTO", "LEGEND_PLACEMENT_BOTTOM", "LEGEND_PLACEMENT_SIDE", "LEGEND_PLACEMENT_HIDDEN" ], "type": "string", "description": "Legend placement." }, "LimitUsage": { "type": "object", "properties": { "limit": { "description": "Limit.", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "used": { "description": "Used.", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Limit usage." }, "LineChart": { "title": "LineChart", "required": [ "queryDefinitions" ], "type": "object", "properties": { "connectNulls": { "description": "Whether the line should remain connected instead of producing scattered points when null values are present in between", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "queryDefinitions": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LineChart.QueryDefinition" }, "description": "Definitions of widget queries" }, "stackedLine": { "allOf": [ { "$ref": "#/components/schemas/LineChart.StackedLine" } ], "description": "Type of stacked line, can be undefined, absolute or relative" }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/Tooltip" } ], "description": "Tooltip settings" }, "useDataTimeRange": { "description": "When used, dashboard or widget time frame is ignored and X axis will represent only dates present in received data which can differ significantly from time ranges that were requested.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis", "x-coralogix-presence": true } }, "description": "LineChart represents the configuration of a line chart widget." }, "LineChart.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query string to search" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "LineChart.LogsQuery": { "type": "object", "properties": { "aggregations": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsAggregation" }, "description": "List of query aggregation functions, it should contain only one element" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names to group the query results" }, "description": "List of field names to group the query results" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of observation fields to group the query results" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "Logs query." }, "LineChart.MetricsQuery": { "type": "object", "properties": { "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder based", "examples": [ "1" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "seriesLimitType": { "allOf": [ { "$ref": "#/components/schemas/MetricsSeriesLimitType" } ], "description": "How to limit the result using series_count_limit parameter", "examples": [ "1" ] }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "Metrics query." }, "LineChart.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/LineChart.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/LineChart.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/LineChart.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/LineChart.SpansQuery" } }, "description": "Discriminated union of possible query types for the line chart widget." }, "LineChart.QueryDefinition": { "title": "LineChart", "required": [ "id", "query" ], "type": "object", "properties": { "colorScheme": { "description": "Applied color scheme for this query, one of the predefined values", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique id of the query definition. If empty or omitted, it is auto-replaced with a generated UUID.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "intervalResolution": { "allOf": [ { "$ref": "#/components/schemas/IntervalResolution" } ], "description": "Interval resolution settings for time bucket calculations, supporting auto or manual modes" }, "isVisible": { "description": "Is the query visible", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Custom name of the query", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/LineChart.Query" } ], "description": "Query object" }, "resolution": { "allOf": [ { "$ref": "#/components/schemas/LineChart.Resolution" } ], "description": "Resolution settings of the query values (deprecated, use interval_resolution instead)", "deprecated": true }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "seriesCountLimit": { "description": "Max count of the series per query", "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "seriesNameTemplate": { "description": "Custom template for the series name", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "LineChart represents the configuration of a line chart widget." }, "LineChart.Resolution": { "title": "Resolution", "type": "object", "properties": { "bucketsPresented": { "description": "How many buckets to present in the selected timeframe (deprecated)", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "interval": { "description": "Interval of value sampling, i.e. every 5 minutes, every 1 second and so on (deprecated)", "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Resolution settings for query values. (deprecated, use interval_resolution instead)." }, "LineChart.SpansQuery": { "type": "object", "properties": { "aggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansAggregation" }, "description": "List of span query aggregation functions, it should contain only one element" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "Lucene query string to search span records" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "Spans query." }, "LineChart.StackedLine": { "enum": [ "STACKED_LINE_UNSPECIFIED", "STACKED_LINE_ABSOLUTE", "STACKED_LINE_RELATIVE" ], "type": "string", "description": "Stacked line." }, "Link": { "title": "Link", "type": "object", "properties": { "key": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The key." }, "text": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The text." }, "url": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL." } } }, "LinkAction": { "type": "object", "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Unique id of the link action" }, "name": { "description": "Name of the link action", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "shouldOpenInNewWindow": { "description": "Defines if the link action should open in a new window or current window in the browser", "type": "boolean", "x-coralogix-presence": true }, "url": { "description": "Static URL that may contain variables using {{variable_name}} syntax", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "LinkCustomEvaluationResponse": { "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 that was linked." }, "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": "Response returned after linking." }, "ListActionsResponse": { "type": "object", "properties": { "actions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v2.Action" }, "description": "List of actions." } } }, "ListAiApplicationsResponse": { "type": "object", "properties": { "aiApplications": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AiApplication" }, "description": "The list of AI applications on this page." } }, "description": "Response containing a page of AI applications." }, "ListAiEvaluationsResponse": { "type": "object", "properties": { "aiEvaluations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AiEvaluation" }, "description": "The list of AI evaluations on this page." } }, "description": "Response containing a page of AI evaluations." }, "ListAlertDefsResponse": { "title": "List alert definitions response", "type": "object", "properties": { "access": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlertDefAccess" }, "description": "The caller's access decision and raw access policy per alert, keyed by alert definition ID" }, "alertDefs": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertDef" }, "description": "List of alert definitions" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/alerts.v3.PaginationResponse" } ], "description": "Pagination settings for the list of alert definitions" } }, "description": "A response that contains a list of alert definitions" }, "ListAlertEventsResponse": { "title": "ListAlertEventsResponse", "required": [ "events" ], "type": "object", "properties": { "events": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CxEvent" }, "description": "List of events." }, "pagination": { "$ref": "#/components/schemas/events.v3.PaginationResponse" } }, "description": "Response containing events associated with the alert" }, "ListAllOutgoingWebhooksResponse": { "title": "List all outgoing webhooks response", "type": "object", "properties": { "deployed": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutgoingWebhookExtendedSummary" }, "description": "The deployed." } }, "description": "Response containing a list of all outgoing webhooks." }, "ListCasesResponse": { "title": "List cases response", "required": [ "cases", "pagination" ], "type": "object", "properties": { "cases": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Case" }, "description": "Cases matching the provided filters." }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/cases.v1.PaginationResponse" } ], "description": "Pagination cursor for retrieving the next page of cases." }, "pbacTruncated": { "type": "boolean", "description": "Indicates whether the list of cases was truncated due to PBAC (Policy-Based Access Control) restrictions. If true, the user may not have access to all cases that match the filters." } }, "description": "Response containing a list of cases and pagination information" }, "ListConfigurationGroupsResponse": { "required": [ "groups" ], "type": "object", "properties": { "groups": { "maxItems": 256, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationGroup" }, "description": "Configuration groups, newest first." }, "nextPageToken": { "description": "Token for the next page. Omitted when there are no further results.", "examples": [ "AZdtCKSZq3sAAAAAAAAAAQ" ], "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string", "x-coralogix-presence": true } }, "description": "Response containing fleet-manager configuration groups." }, "ListConfigurationOverlaysResponse": { "required": [ "overlays" ], "type": "object", "properties": { "nextPageToken": { "description": "Token for the next page. Omitted when there are no further results.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "type": "string", "x-coralogix-presence": true }, "overlays": { "maxItems": 256, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationOverlay" }, "description": "Configuration overlays, newest first." } }, "description": "Response containing configuration overlays." }, "ListConnectorSummariesResponse": { "title": "List Connector Summaries Response", "type": "object", "properties": { "connectors": { "maxItems": 800, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSummary" }, "description": "The connectors." } }, "description": "Response containing summaries of connectors", "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", "properties": { "connectors": { "maxItems": 800, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Connector" }, "description": "The connectors." } }, "description": "Response containing a list of connectors", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ListCustomEvaluationsForApplicationResponse": { "type": "object", "properties": { "items": { "maxItems": 1024, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CustomEvaluation" }, "description": "Custom evaluations linked to the application." } }, "description": "Response containing custom evaluations linked to the application." }, "ListCustomRolesResponse": { "type": "object", "properties": { "roles": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CustomRole" }, "description": "List of roles." } }, "description": "Response containing a list of custom roles." }, "ListDashboardFoldersResponse": { "title": "List dashboard folders response data structure", "type": "object", "properties": { "folder": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DashboardFolder" }, "description": "The folder." } }, "description": "Response containing a list of dashboard folders.", "externalDocs": { "description": "Find out more Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "ListE2MResponse": { "title": "List E2M Response", "required": [ "e2m" ], "type": "object", "properties": { "e2m": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/E2M" }, "description": "The e2m." } }, "description": "This is the response obtained when listing all event to metric definitions", "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "ListEntitySubTypesResponse": { "type": "object", "properties": { "entitySubTypes": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The entity sub types." }, "description": "The entity sub types." } }, "description": "Response containing a list of notification entity sub-types." }, "ListEntityTypeAttachmentTypesResponse": { "type": "object", "properties": { "supportedAttachmentTypes": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/EntityTypeAttachmentType" }, "description": "The supported attachment types." } }, "description": "Response containing a list of supported attachment types for the entity type." }, "ListEntityTypesResponse": { "type": "object", "properties": { "entityTypes": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/notification_center.EntityType" }, "description": "The supported payload types." } }, "description": "Response containing a list of notification entity types." }, "ListEventsCountResponse": { "title": "ListEventsCountResponse", "required": [ "count", "reachedLimit" ], "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ "10" ], "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "reachedLimit": { "description": "The reached limit.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true } } }, "ListGlobalRoutersResponse": { "title": "List Global Routers Response", "type": "object", "properties": { "routers": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/GlobalRouter" }, "description": "The routers." } }, "description": "Response containing requested global routers", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ListIncidentAggregationsResponse": { "title": "List incident aggregations response", "required": [ "incidentAggs", "pagination" ], "type": "object", "properties": { "incidentAggs": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentAggregation" }, "description": "List of incident aggregations" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/incidents.v1.PaginationResponse" } ], "description": "Pagination information for the response" } }, "description": "Response containing aggregated incident data and pagination information" }, "ListIncidentEventsFilterValuesResponse": { "title": "List incident events filter values response", "type": "object", "properties": { "filtersValues": { "allOf": [ { "$ref": "#/components/schemas/IncidentQueryFiltersValues" } ], "description": "Available filter values for incident events" } }, "description": "A response containing available filter values for incident events" }, "ListIncidentEventsResponse": { "title": "List incident events response", "required": [ "items" ], "type": "object", "properties": { "items": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/IncidentEventExtended" }, "description": "List of incident events" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/incidents.v1.PaginationResponse" } ], "description": "Pagination information for the response" } }, "description": "A response containing a list of incident events and pagination information" }, "ListIncidentEventsTotalCountResponse": { "title": "List incident events total count response", "type": "object", "properties": { "count": { "description": "Total number of incident events matching the filter", "examples": [ "100" ], "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "reachedLimit": { "description": "Indicates if the count reached the system limit", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true } }, "description": "A response containing the total count of matching incident events and whether the count limit was reached" }, "ListIncidentsResponse": { "title": "List incidents response", "required": [ "incidents", "pagination" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "Incidents." }, "pagination": { "$ref": "#/components/schemas/incidents.v1.PaginationResponse" } }, "description": "Response containing a list of incidents and pagination information" }, "ListLabelsCardinalityResponse": { "type": "object", "properties": { "permutations": { "maxItems": 366, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LabelsPermutationsCardinalityDay" }, "description": "List of permutations." } }, "description": "Response containing label cardinality data for events-to-metrics rules." }, "ListManagedIntegrationKeysResponse": { "title": "List managed integration keys response", "type": "object", "properties": { "integrationKeys": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The integration keys." }, "description": "The integration keys." } }, "description": "Response containing a list of managed integration keys." }, "ListNotificationDeliveriesResponse": { "title": "List notification deliveries response", "required": [ "deliveriesByCase" ], "type": "object", "properties": { "deliveriesByCase": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CaseNotificationDeliveries" }, "description": "Notification deliveries keyed by case ID" } }, "description": "Response containing a list of notification delivery records for cases." }, "ListOutboundWebhooksSummaryResponse": { "title": "List outbound webhooks summary response", "type": "object", "properties": { "outboundWebhookSummaries": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutboundWebhookSummary" }, "description": "The outbound webhook summaries." } }, "description": "Response containing summary information for outgoing webhooks." }, "ListOutgoingWebhookTypesResponse": { "title": "List outgoing webhook types response", "type": "object", "properties": { "webhooks": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutgoingWebhookType" }, "description": "List of webhooks." } }, "description": "Response containing a list of available outgoing webhook types." }, "ListOutgoingWebhooksResponse": { "title": "List outgoing webhooks response", "type": "object", "properties": { "deployed": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutgoingWebhookSummary" }, "description": "The deployed." } }, "description": "Response containing a list of outgoing webhooks." }, "ListPresetSummariesResponse": { "type": "object", "properties": { "presetSummaries": { "maxItems": 600, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PresetSummary" }, "description": "The preset summaries." } }, "description": "Response containing a list of notification preset summaries." }, "ListRuleGroupsResponse": { "type": "object", "properties": { "ruleGroups": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RuleGroup" }, "description": "The rule groups." } }, "description": "Response containing a list of parsing rule groups." }, "ListSlosResponse": { "title": "ListSlosResponse", "required": [ "slos" ], "type": "object", "properties": { "slos": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Slo" }, "description": "The slos." } }, "description": "Response containing a list of SLOs." }, "ListSystemRolesResponse": { "type": "object", "properties": { "roles": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SystemRole" }, "description": "List of roles." } }, "description": "Response containing a list of system roles." }, "ListTeamsResponse": { "type": "object", "properties": { "defaultTeam": { "allOf": [ { "$ref": "#/components/schemas/ListTeamsResponse.TeamInfo" } ], "description": "The organization's default team." }, "teams": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ListTeamsResponse.TeamInfo" }, "description": "Every team in the organization, including the default team." } }, "description": "Response containing the teams in the calling user's organization." }, "ListTeamsResponse.TeamInfo": { "type": "object", "properties": { "dailyQuota": { "type": "number", "description": "Daily quota assigned to the team, in quota units per day.", "format": "double" }, "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": "The team id." }, "teamName": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name of the team. Unique in the organization; never empty." } }, "description": "A team and the quota and retention settings assigned to it." }, "ListTextValue": { "title": "List text value", "type": "object", "properties": { "defaultValues": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The default values." }, "description": "The default values." }, "options": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Options." }, "description": "Options." } }, "description": "List text value." }, "ListValue": { "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SingleStringValue" }, "description": "List of values." } }, "description": "List value." }, "ListViewFoldersResponse": { "type": "object", "properties": { "folders": { "maxItems": 100000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ViewFolder" }, "description": "The folders." } }, "description": "Response containing a list of view folders." }, "ListViewsResponse": { "type": "object", "properties": { "views": { "maxItems": 100000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/View" }, "description": "The views." } }, "description": "Response containing a list of views." }, "LocalChangelog": { "title": "Local changelog", "type": "object", "properties": { "changes": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RevisionRef" }, "description": "The changes." } }, "description": "Local changelog." }, "LogAttachment": { "title": "Log attachment", "required": [ "logId", "logTimestamp", "logContent" ], "type": "object", "properties": { "logContent": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Raw content of the log entry. Leading and trailing whitespace is trimmed before the length limits are applied.", "examples": [ "ERROR: Database connection timeout after 30 seconds" ] }, "logId": { "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 log entry", "examples": [ "9c858901-8a57-4791-81fe-4c455b099bc9" ] }, "logTimestamp": { "description": "Timestamp when the log entry was created", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "queryLinkSuffix": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL suffix for querying related logs (not including the Coralogix domain part)", "examples": [ "/logs/query?time=123456789&query=error" ] } }, "description": "Attachment containing log data and related information" }, "LogFilterOperationType": { "enum": [ "LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED", "LOG_FILTER_OPERATION_TYPE_INCLUDES", "LOG_FILTER_OPERATION_TYPE_ENDS_WITH", "LOG_FILTER_OPERATION_TYPE_STARTS_WITH" ], "type": "string", "description": "Log filter operation type." }, "LogMetaFieldsValues": { "title": "Log Meta Fields Values", "required": [ "applicationNameValues", "severityValues", "subsystemNameValues" ], "type": "object", "properties": { "applicationNameValues": { "description": "The application name values.", "examples": [ "application_name" ], "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severityValues": { "description": "The severity values.", "examples": [ "severity" ], "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "subsystemNameValues": { "description": "The subsystem name values.", "examples": [ "subsystem_name" ], "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Values for log meta fields.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "LogMetadata": { "title": "Log metadata", "type": "object", "properties": { "firstOccurrence": { "description": "The first occurrence.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "lastOccurrence": { "description": "The last occurrence.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Log metadata." }, "LogRules": { "title": "Log Rules", "type": "object", "properties": { "dpxlExpression": { "description": "The DataPrime expression that selects the data. It starts with a version tag, for example ` $d.severity == 'INFO'`; the service rejects an expression without one.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severities": { "description": "The severities. A request without `dpxlExpression` needs at least one, and a request with it must have none. A response with `dpxlExpression` has an empty list.", "items": { "$ref": "#/components/schemas/quota.v1.Severity" }, "maxItems": 6, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Log rules for a policy. Set `severities` or `dpxlExpression`, not both.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "LogSeverity": { "enum": [ "LOG_SEVERITY_VERBOSE_UNSPECIFIED", "LOG_SEVERITY_DEBUG", "LOG_SEVERITY_INFO", "LOG_SEVERITY_WARNING", "LOG_SEVERITY_ERROR", "LOG_SEVERITY_CRITICAL" ], "type": "string" }, "Logs": { "title": "LogsQuery", "type": "object", "properties": { "aggregation": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LogsAggregation" }, "description": "Aggregation function" }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of observation fields by which to group the results" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" } }, "description": "A logs variant of the query" }, "LogsAggregation": { "type": "object", "oneOf": [ { "required": [ "count" ], "type": "object" }, { "required": [ "countDistinct" ], "type": "object" }, { "required": [ "sum" ], "type": "object" }, { "required": [ "average" ], "type": "object" }, { "required": [ "min" ], "type": "object" }, { "required": [ "max" ], "type": "object" }, { "required": [ "percentile" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "count" ], "type": "object" }, { "required": [ "countDistinct" ], "type": "object" }, { "required": [ "sum" ], "type": "object" }, { "required": [ "average" ], "type": "object" }, { "required": [ "min" ], "type": "object" }, { "required": [ "max" ], "type": "object" }, { "required": [ "percentile" ], "type": "object" } ] } } ], "properties": { "average": { "$ref": "#/components/schemas/Average" }, "count": { "$ref": "#/components/schemas/Count" }, "countDistinct": { "$ref": "#/components/schemas/CountDistinct" }, "max": { "$ref": "#/components/schemas/Max" }, "min": { "$ref": "#/components/schemas/Min" }, "percentile": { "$ref": "#/components/schemas/Percentile" }, "sum": { "$ref": "#/components/schemas/Sum" } }, "description": "Discriminated union of logs aggregation functions such as count, sum, average, min, max, and percentile." }, "LogsAnomalyCondition": { "title": "Log-based anomaly condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/LogsAnomalyConditionType" } ], "description": "The type of condition for the alert", "examples": [ "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ] }, "minimumThreshold": { "description": "The threshold value for the alert condition", "examples": [ 10 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeWindow" } ], "description": "The time window for the alert condition" } }, "description": "Defines conditions for detecting log anomalies" }, "LogsAnomalyConditionType": { "enum": [ "LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED" ], "type": "string", "description": "Logs anomaly condition type." }, "LogsAnomalyRule": { "title": "Log-based anomaly rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsAnomalyCondition" } ], "description": "The condition for the threshold alert" } }, "description": "Defines a rule for detecting log anomalies" }, "LogsAnomalyType": { "title": "Log-based anomaly alert type", "type": "object", "properties": { "anomalyAlertSettings": { "allOf": [ { "$ref": "#/components/schemas/AnomalyAlertSettings" } ], "description": "Anomaly alert settings configuration" }, "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "logsFilter": { "$ref": "#/components/schemas/v3.LogsFilter" }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The filter to specify which fields to include in the notification payload" }, "description": "The filter to specify which fields to include in the notification payload", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsAnomalyRule" }, "description": "The rules for the log anomaly alert" } }, "description": "Configuration for alerts triggered by anomalous log patterns", "externalDocs": { "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/" } }, "LogsImmediateType": { "title": "Logs immediate alert type", "type": "object", "properties": { "logsFilter": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for immediate alerts." }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The notification payload filter." }, "description": "The notification payload filter.", "examples": [ [ "obj.field" ] ] } }, "description": "Configuration for immediate alerts triggered on log entries matching specific filters.", "externalDocs": { "description": "Learn more about logs immediate alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/immediate-notifications/" } }, "LogsLink": { "title": "Logs link", "type": "object", "properties": { "logs": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Explore logs URL pre-filtered to the alert query and case time window." } }, "description": "Deep link to explore logs related to an alert indicator on a case." }, "LogsNewValueCondition": { "title": "Log-based new value condition", "type": "object", "properties": { "keypathToTrack": { "description": "The keypath to track for new values", "examples": [ "metadata.field" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/LogsNewValueTimeWindow" } ], "description": "The time window for detecting new values" } }, "description": "Defines conditions for detecting new values in logs" }, "LogsNewValueRule": { "title": "Log-based new value rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsNewValueCondition" } ], "description": "The condition for detecting new values in logs." } }, "description": "Defines the condition for detecting new values in logs" }, "LogsNewValueTimeWindow": { "title": "Log-based new value alert time window", "type": "object", "properties": { "logsNewValueTimeWindowSpecificValue": { "allOf": [ { "$ref": "#/components/schemas/LogsNewValueTimeWindowValue" } ], "description": "A time window defined by a specific value", "examples": [ "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED" ] } }, "description": "Time window configuration for log-based new value alerts" }, "LogsNewValueTimeWindowValue": { "enum": [ "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_24", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_48", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_72", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_WEEK_1", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTH_1", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_2", "LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_3" ], "type": "string", "description": "Logs new value time window value." }, "LogsNewValueType": { "title": "Log-based new value alert type", "type": "object", "properties": { "logsFilter": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for the alert." }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The filter to specify which fields to include in the notification payload." }, "description": "The filter to specify which fields to include in the notification payload.", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsNewValueRule" }, "description": "The rules for the log new value alert." } }, "description": "Configuration for alerts triggered by new values appearing in logs" }, "LogsPathSource": { "type": "object", "properties": { "observationField": { "$ref": "#/components/schemas/ObservationField" }, "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Logs path source." }, "LogsPolicySettings": { "title": "Logs Source Policy", "type": "object", "properties": { "defaultPriority": { "$ref": "#/components/schemas/quota.v1.Priority" } } }, "LogsQuery.Aggregation": { "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Type of aggregation function" }, "id": { "description": "Aggregation unique identifier", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isVisible": { "description": "Whether the aggregation is visible in the table", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Aggregation name", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Aggregation." }, "LogsQuery.Grouping": { "type": "object", "properties": { "aggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LogsQuery.Aggregation" }, "description": "List of aggregations" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names to group the query results" }, "description": "List of field names to group the query results" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields to group the results" } }, "description": "Logs query.grouping." }, "LogsRatioCondition": { "title": "Log-based ratio condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioConditionType" } ], "description": "The type of condition for the alert", "examples": [ "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ] }, "threshold": { "description": "The threshold value for the alert condition", "examples": [ 10 ], "format": "double", "minimum": 0, "type": "number", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioTimeWindow" } ], "description": "The time window for the alert condition", "examples": [ 10 ] } }, "description": "Defines conditions for ratio-based alerts" }, "LogsRatioConditionType": { "enum": [ "LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED", "LOGS_RATIO_CONDITION_TYPE_LESS_THAN" ], "type": "string", "description": "Logs ratio condition type." }, "LogsRatioGroupByFor": { "enum": [ "LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED", "LOGS_RATIO_GROUP_BY_FOR_NUMERATOR_ONLY", "LOGS_RATIO_GROUP_BY_FOR_DENUMERATOR_ONLY" ], "type": "string", "description": "Logs ratio group by for." }, "LogsRatioRules": { "title": "Log-based ratio rules", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioCondition" } ], "description": "The condition for the ratio alert" }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "The override settings for the alert" } }, "description": "Defines the rules for log-based ratio alerts" }, "LogsRatioThresholdType": { "title": "Log-based ratio threshold alert type", "type": "object", "properties": { "denominator": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for the denominator of the ratio" }, "denominatorAlias": { "description": "The alias for the denominator filter, used for display purposes", "examples": [ "denominator_alias" ], "maxLength": 200, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "groupByFor": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioGroupByFor" } ], "description": "The group by settings for the numerator and denominator filters", "examples": [ "LOGS_RATIO_GROUP_BY_FOR_NUMERATOR_ONLY" ] }, "ignoreInfinity": { "description": "The configuration for ignoring infinity values in the ratio", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The notification payload filter." }, "description": "The notification payload filter.", "examples": [ [ "obj.field" ] ] }, "numerator": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for the numerator of the ratio" }, "numeratorAlias": { "description": "The alias for the numerator filter, used for display purposes", "examples": [ "numerator_alias" ], "maxLength": 200, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsRatioRules" }, "description": "The rules for the ratio alert" }, "undetectedValuesManagement": { "allOf": [ { "$ref": "#/components/schemas/v3.UndetectedValuesManagement" } ], "description": "Configuration for handling the undetected values in the alert" } }, "description": "Configuration for alerts based on the ratio between two log queries", "externalDocs": { "description": "Learn more about logs ratio alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/ratio-alerts/" } }, "LogsRatioTimeWindow": { "title": "Logs ratio time window", "type": "object", "properties": { "logsRatioTimeWindowSpecificValue": { "allOf": [ { "$ref": "#/components/schemas/LogsRatioTimeWindowValue" } ], "description": "Specifies the time window for the ratio alert", "examples": [ "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED" ] } }, "description": "Time window configuration for ratio alerts", "externalDocs": { "description": "Learn more about log-based ratio alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/ratio-alerts/" } }, "LogsRatioTimeWindowValue": { "enum": [ "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED", "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_10", "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_15", "LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_30", "LOGS_RATIO_TIME_WINDOW_VALUE_HOUR_1", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_2", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_4", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_6", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_12", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_24", "LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_36" ], "type": "string", "description": "Logs ratio time window value." }, "LogsSimpleFilter": { "title": "Simple log filter", "type": "object", "properties": { "labelFilters": { "$ref": "#/components/schemas/LabelFilters" }, "luceneQuery": { "description": "The lucene query.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Basic filter configuration using a Lucene query and label filters" }, "LogsSource": { "type": "object", "properties": { "dataModeType": { "$ref": "#/components/schemas/v1.common.DataModeType" }, "labelFields": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The label fields." }, "luceneQuery": { "$ref": "#/components/schemas/LuceneQuery" }, "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "strategy": { "$ref": "#/components/schemas/LogsSource.Strategy" } }, "description": "Logs source." }, "LogsSource.Strategy": { "type": "object", "oneOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ] } } ], "properties": { "duration": { "allOf": [ { "$ref": "#/components/schemas/LogsSource.Strategy.Duration" } ], "description": "Duration." }, "instant": { "$ref": "#/components/schemas/LogsSource.Strategy.Instant" }, "range": { "$ref": "#/components/schemas/LogsSource.Strategy.Range" } }, "description": "Determines the time strategy for fetching logs (instant snapshot, fixed range, or sliding window)." }, "LogsSource.Strategy.Duration": { "type": "object", "properties": { "durationField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Duration strategy: uses a start timestamp and a duration field to define the annotation span." }, "LogsSource.Strategy.Instant": { "type": "object", "properties": { "timestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Instant snapshot strategy: uses a single timestamp field to define the annotation point." }, "LogsSource.Strategy.Range": { "type": "object", "properties": { "endTimestampField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Range strategy: uses start and end timestamp fields to define the annotation span." }, "LogsThresholdCondition": { "title": "Logs Threshold Condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/LogsThresholdConditionType" } ], "description": "The type of condition for the alert", "examples": [ "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ] }, "threshold": { "description": "The threshold value for the alert condition", "examples": [ 100 ], "format": "double", "minimum": 0, "type": "number", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeWindow" } ], "description": "The time window for the alert condition" } }, "description": "LogsThresholdCondition is a message that defines the condition for log-based threshold alerts." }, "LogsThresholdConditionType": { "enum": [ "LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED", "LOGS_THRESHOLD_CONDITION_TYPE_LESS_THAN", "LOGS_THRESHOLD_CONDITION_TYPE_EQUALS", "LOGS_THRESHOLD_CONDITION_TYPE_NOT_EQUALS" ], "type": "string", "description": "Logs threshold condition type." }, "LogsThresholdRule": { "title": "Logs Threshold Rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsThresholdCondition" } ], "description": "The condition for the threshold alert" }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "The override settings for the alert" } }, "description": "LogsThresholdRule is a message that defines a rule for log-based threshold alerts." }, "LogsThresholdType": { "title": "Log-based threshold alert type", "type": "object", "properties": { "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "logsFilter": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for threshold alerts" }, "noDataPolicy": { "allOf": [ { "$ref": "#/components/schemas/NoDataPolicy" } ], "description": "User configuration to decide how to treat and what state to give to an alert with no data. Applies only when the alert's alertDefProperties.groupByKeys contains at least one key: an alert without group-by keys evaluates a time window with no matching logs as a count of 0 against its threshold, whatever this policy says." }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The filter to specify which fields to include in the notification payload" }, "description": "The filter to specify which fields to include in the notification payload", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsThresholdRule" }, "description": "The rules for the threshold alert" }, "undetectedValuesManagement": { "allOf": [ { "$ref": "#/components/schemas/v3.UndetectedValuesManagement" } ], "description": "Configuration for handling the undetected values in the alert" } }, "description": "Configuration for alerts triggered when log counts exceed or fall below specified thresholds", "externalDocs": { "description": "Learn more about log-based threshold alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/threshold-alerts/" } }, "LogsTimeRelativeComparedTo": { "enum": [ "LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED", "LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_YESTERDAY", "LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_LAST_WEEK", "LOGS_TIME_RELATIVE_COMPARED_TO_YESTERDAY", "LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_WEEK", "LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_MONTH" ], "type": "string", "description": "Logs time relative compared to." }, "LogsTimeRelativeCondition": { "title": "Log-based time-relative condition", "type": "object", "properties": { "comparedTo": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeRelativeComparedTo" } ], "description": "The time frame to compare the current value against", "examples": [ "LOGS_TIME_RELATIVE_COMPARED_TO_YESTERDAY" ] }, "conditionType": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeRelativeConditionType" } ], "description": "The type of condition for the alert", "examples": [ "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ] }, "threshold": { "description": "The threshold value for the alert condition.", "format": "double", "minimum": 0, "type": "number", "x-coralogix-presence": true } }, "description": "Defines conditions for time-relative comparison alerts" }, "LogsTimeRelativeConditionType": { "enum": [ "LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED", "LOGS_TIME_RELATIVE_CONDITION_TYPE_LESS_THAN" ], "type": "string", "description": "Logs time relative condition type." }, "LogsTimeRelativeRule": { "title": "Logs Time Relative Rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeRelativeCondition" } ], "description": "The condition for the time-relative alert." }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "The override settings for the alert." } }, "description": "LogsTimeRelativeRule is a message that defines a rule for log-based time-relative alerts" }, "LogsTimeRelativeThresholdType": { "title": "Log-based time-relative threshold alert type", "type": "object", "properties": { "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ignoreInfinity": { "description": "Ignore infinity values in the alert", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "logsFilter": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for the alert." }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The notification payload filter." }, "description": "The notification payload filter.", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsTimeRelativeRule" }, "description": "The rules for the time-relative alert" }, "undetectedValuesManagement": { "allOf": [ { "$ref": "#/components/schemas/v3.UndetectedValuesManagement" } ], "description": "Configuration for handling the undetected values in the alert." } }, "description": "Configuration for alerts that are triggered when a fixed ratio reaches a set threshold compared to a past time frame.", "externalDocs": { "description": "Learn more about log-based, time-relative alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/time-relative-alerts/" } }, "LogsTimeWindow": { "title": "Log-based alert time window", "type": "object", "properties": { "logsTimeWindowSpecificValue": { "allOf": [ { "$ref": "#/components/schemas/LogsTimeWindowValue" } ], "description": "A time window defined by a specific value", "examples": [ "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED" ] } }, "description": "Time window configuration for log-based alerts" }, "LogsTimeWindowValue": { "enum": [ "LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED", "LOGS_TIME_WINDOW_VALUE_MINUTES_10", "LOGS_TIME_WINDOW_VALUE_MINUTES_20", "LOGS_TIME_WINDOW_VALUE_MINUTES_15", "LOGS_TIME_WINDOW_VALUE_MINUTES_30", "LOGS_TIME_WINDOW_VALUE_HOUR_1", "LOGS_TIME_WINDOW_VALUE_HOURS_2", "LOGS_TIME_WINDOW_VALUE_HOURS_4", "LOGS_TIME_WINDOW_VALUE_HOURS_6", "LOGS_TIME_WINDOW_VALUE_HOURS_12", "LOGS_TIME_WINDOW_VALUE_HOURS_24", "LOGS_TIME_WINDOW_VALUE_HOURS_36" ], "type": "string", "description": "Logs time window value." }, "LogsUniqueCountCondition": { "title": "Logs unique count condition", "type": "object", "properties": { "maxUniqueCount": { "description": "The maximum unique count", "examples": [ "100" ], "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/LogsUniqueValueTimeWindow" } ], "description": "The time window for the unique count alert." } }, "description": "Defines conditions for unique count alerts" }, "LogsUniqueCountRule": { "title": "Log-based unique count rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/LogsUniqueCountCondition" } ], "description": "The condition for detecting unique counts in logs." } }, "description": "Defines the rule for detecting unique counts in logs" }, "LogsUniqueCountType": { "title": "Log-based unique count alert type", "type": "object", "properties": { "logsFilter": { "allOf": [ { "$ref": "#/components/schemas/v3.LogsFilter" } ], "description": "The filter to match log entries for the alert." }, "maxUniqueCountPerGroupByKey": { "description": "The maximum unique count per group by key", "examples": [ "100" ], "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The filter to specify which fields to include in the notification payload" }, "description": "The filter to specify which fields to include in the notification payload", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LogsUniqueCountRule" }, "description": "The rules for the log unique count alert" }, "uniqueCountKeypath": { "description": "The keypath in the logs to be used for unique count", "examples": [ "obj.field" ], "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Configuration for alerts based on unique value counts in logs", "externalDocs": { "description": "Learn more about log-based, unique count alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/logs/unique-count-alerts/" } }, "LogsUniqueValueTimeWindow": { "title": "Log-based unique value alert time window", "type": "object", "properties": { "logsUniqueValueTimeWindowSpecificValue": { "allOf": [ { "$ref": "#/components/schemas/LogsUniqueValueTimeWindowValue" } ], "description": "A time window defined by a specific value", "examples": [ "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_12" ] } }, "description": "Time window configuration for log-based unique value alerts" }, "LogsUniqueValueTimeWindowValue": { "enum": [ "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_5", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_10", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_15", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_20", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_30", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_1", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_2", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_4", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_6", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_12", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_24", "LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_36" ], "type": "string", "description": "Logs unique value time window value." }, "LuceneQuery": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Lucene query." }, "LuceneQueryValue": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/StringValueLabel" } ], "description": "The value." } }, "description": "Lucene query value." }, "MSTeamsWorkflowConfig": { "title": "Microsoft Teams workflow configuration", "type": "object", "additionalProperties": false, "description": "Ms teams workflow config." }, "Managed": { "title": "Managed", "type": "object", "properties": { "variant": { "$ref": "#/components/schemas/Variant" } } }, "ManagedService": { "title": "Managed service", "type": "object", "additionalProperties": false }, "ManualIntervalResolution": { "title": "ManualIntervalResolution", "required": [ "interval" ], "type": "object", "properties": { "interval": { "description": "Fixed interval duration for time buckets, specified by the user.", "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "maximumDataPoints": { "description": "Maximum number of data points constraint.", "examples": [ 500 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "minimumInterval": { "description": "Minimum interval duration constraint. The selected interval will not be smaller than this value.", "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Manual interval resolution with a fixed, user-specified interval for time buckets. Optionally supports minimum interval and maximum data points constraints." }, "ManualSource": { "type": "object", "properties": { "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "orientation": { "$ref": "#/components/schemas/AnnotationOrientation" }, "strategy": { "$ref": "#/components/schemas/ManualSource.Strategy" } }, "description": "Manual source." }, "ManualSource.Strategy": { "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/ManualSource.Strategy.Instant" }, "range": { "$ref": "#/components/schemas/ManualSource.Strategy.Range" } }, "description": "Defines the time positioning strategy for manually placed annotations (instant point or range)." }, "ManualSource.Strategy.Instant": { "type": "object", "properties": { "customUnit": { "description": "The custom unit.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "unit": { "$ref": "#/components/schemas/common.Unit" }, "value": { "description": "The value.", "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Instant strategy: places the annotation at a specific absolute timestamp value." }, "ManualSource.Strategy.Range": { "type": "object", "properties": { "customUnit": { "description": "The custom unit.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "endValue": { "description": "The end value.", "format": "double", "type": "number", "x-coralogix-presence": true }, "startValue": { "description": "The start value.", "format": "double", "type": "number", "x-coralogix-presence": true }, "unit": { "$ref": "#/components/schemas/common.Unit" } }, "description": "Range strategy: places the annotation spanning between two absolute timestamp values." }, "MappedValues": { "type": "object", "additionalProperties": false, "description": "Mapped values." }, "MappingSection": { "title": "MappingSection", "type": "object", "properties": { "color": { "allOf": [ { "$ref": "#/components/schemas/ColorSolidType" } ], "description": "Color for this mapping section" }, "mapTo": { "description": "Display text to map the matched value to", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "Value to match (exact string for value mapping, regex pattern for regex mapping)", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "A single mapping entry that maps a value (exact or regex) to a display text and color" }, "Markdown": { "type": "object", "properties": { "markdownText": { "description": "Markdown text", "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "tooltipText": { "description": "Tooltip text to display on widget hover", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Markdown." }, "MatchEntityTypeAndSubTypeCondition": { "type": "object", "properties": { "entitySubType": { "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The entity sub type." } }, "description": "Match entity type and sub type condition." }, "MatchEntityTypeCondition": { "type": "object", "additionalProperties": false, "description": "Match entity type condition." }, "Max": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Max." }, "MessageConfig": { "type": "object", "properties": { "fields": { "description": "List of fields. The server does not keep the order of the fields, and a repeated field name keeps one entry.", "items": { "$ref": "#/components/schemas/notification_center.MessageConfigField" }, "maxItems": 100, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Message config." }, "MessageConfigSchema": { "type": "object", "properties": { "fields": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MessageConfigSchemaField" }, "description": "List of fields." }, "payloadType": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Type of the payload." } } }, "MessageConfigSchemaField": { "type": "object", "properties": { "allowedValues": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The allowed values." }, "description": "The allowed values." }, "default": { "description": "The default.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "disableOverride": { "description": "The disable override.", "type": "boolean", "x-coralogix-presence": true }, "fieldName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name." }, "fieldType": { "$ref": "#/components/schemas/FieldType" }, "renderingMode": { "$ref": "#/components/schemas/TemplateRenderingMode" }, "required": { "type": "boolean", "description": "The required." } } }, "MetaLabels": { "type": "object", "properties": { "value": { "description": "The value.", "items": { "$ref": "#/components/schemas/meta_labels_protobuf.v1.MetaLabel" }, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Meta labels." }, "MetadataField": { "enum": [ "METADATA_FIELD_UNSPECIFIED", "METADATA_FIELD_APPLICATION_NAME", "METADATA_FIELD_SUBSYSTEM_NAME", "METADATA_FIELD_SERVICE_NAME", "METADATA_FIELD_OPERATION_NAME" ], "type": "string", "description": "Metadata field." }, "MethodType": { "enum": [ "UNKNOWN", "GET", "POST", "PUT" ], "type": "string", "description": "Method type." }, "Metric": { "title": "Metric", "required": [ "query" ], "type": "object", "properties": { "query": { "minLength": 1, "type": "string", "description": "Query string. Required. A missing or empty query is rejected.", "examples": [ "sum(rate(http_requests_total{status=\"200\"}[1m]))" ] } }, "description": "Definition of a metric used in SLOs" }, "MetricAggregation": { "type": "object", "properties": { "aggregationType": { "$ref": "#/components/schemas/MetricAggregationType" }, "metricField": { "$ref": "#/components/schemas/MetricAggregation.MetricField" } }, "description": "Metric aggregation." }, "MetricAggregation.MetricField": { "enum": [ "METRIC_FIELD_UNSPECIFIED", "METRIC_FIELD_DURATION" ], "type": "string", "description": "Span metric field to aggregate, currently supports duration." }, "MetricAggregationType": { "enum": [ "METRIC_AGGREGATION_TYPE_UNSPECIFIED", "METRIC_AGGREGATION_TYPE_MIN", "METRIC_AGGREGATION_TYPE_MAX", "METRIC_AGGREGATION_TYPE_AVERAGE", "METRIC_AGGREGATION_TYPE_SUM", "METRIC_AGGREGATION_TYPE_PERCENTILE_99", "METRIC_AGGREGATION_TYPE_PERCENTILE_95", "METRIC_AGGREGATION_TYPE_PERCENTILE_50" ], "type": "string", "description": "Metric aggregation type." }, "MetricAnomalyCondition": { "title": "Metric-based anomaly condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/MetricAnomalyConditionType" } ], "description": "The type of condition for the alert.", "examples": [ "METRIC_ANOMALY_CONDITION_TYPE_LESS_THAN_USUAL" ] }, "forOverPct": { "description": "The percentage of the metric that must exceed the threshold to trigger the alert", "examples": [ 20 ], "format": "int64", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "minNonNullValuesPct": { "description": "The percentage of non-null values required to trigger the alert", "examples": [ 10 ], "format": "int64", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ofTheLast": { "allOf": [ { "$ref": "#/components/schemas/MetricTimeWindow" } ], "description": "The time window for the alert condition." }, "threshold": { "description": "The threshold value for the alert condition", "examples": [ 10 ], "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Metric anomaly condition." }, "MetricAnomalyConditionType": { "enum": [ "METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED", "METRIC_ANOMALY_CONDITION_TYPE_LESS_THAN_USUAL" ], "type": "string", "description": "Metric anomaly condition type." }, "MetricAnomalyRule": { "title": "Metric-based anomaly rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/MetricAnomalyCondition" } ], "description": "The condition for the metric anomaly alert." } }, "description": "A rule for metric-based anomaly detection alerts" }, "MetricAnomalyType": { "title": "Metric-based anomaly alert type", "type": "object", "properties": { "anomalyAlertSettings": { "allOf": [ { "$ref": "#/components/schemas/AnomalyAlertSettings" } ], "description": "Configuration for anomaly alert settings." }, "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "metricFilter": { "allOf": [ { "$ref": "#/components/schemas/MetricFilter" } ], "description": "The filter to match metric entries for the alert." }, "rules": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/MetricAnomalyRule" }, "description": "The rules for the metric anomaly alert." } }, "description": "Configuration for alerts triggered by anomalous metric patterns", "externalDocs": { "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/" } }, "MetricFilter": { "title": "Metric filter configuration in alerts", "type": "object", "properties": { "promql": { "description": "A PromQL filter for metrics", "examples": [ "avg_over_time(metric_name[5m]) > 10" ], "maxLength": 65535, "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Metric filter." }, "MetricLabel": { "title": "Metric Label", "required": [ "targetLabel", "sourceField" ], "type": "object", "properties": { "sourceField": { "description": "The source field.", "examples": [ "log_obj.string_value" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targetLabel": { "description": "The target label.", "examples": [ "alias_label_name" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\w/-]+$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "MetricLabelSource": { "type": "object", "properties": { "label": { "description": "The label.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "metricName": { "description": "The metric name.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Metric label source." }, "MetricLink": { "title": "Metric link", "type": "object", "properties": { "metrics": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Explore metrics URL pre-filtered to the alert query and case time window." } }, "description": "Deep link to explore metrics related to an alert indicator on a case." }, "MetricMissingValues": { "title": "Metric Missing Values Configuration", "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": { "description": "If set, specifies the minimum percentage of non-null values required for the alert to be triggered", "examples": [ 80 ], "format": "int64", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "replaceWithZero": { "description": "If set to true, missing values will be replaced with zero", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Configuration for handling missing values in metric threshold alerts." }, "MetricThresholdCondition": { "title": "Metric Threshold Condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/MetricThresholdConditionType" } ], "description": "The type of the alert condition", "examples": [ "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_EQUALS" ] }, "forOverPct": { "description": "The percentage of values that must exceed the threshold to trigger the alert", "examples": [ 80 ], "format": "int64", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ofTheLast": { "allOf": [ { "$ref": "#/components/schemas/MetricTimeWindow" } ], "description": "The time window for the alert condition" }, "threshold": { "description": "The threshold value for the alert condition", "examples": [ 100 ], "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Defines conditions for metric threshold alerts" }, "MetricThresholdConditionType": { "enum": [ "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED", "METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN", "METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_EQUALS", "METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN_OR_EQUALS", "METRIC_THRESHOLD_CONDITION_TYPE_EQUALS", "METRIC_THRESHOLD_CONDITION_TYPE_NOT_EQUALS" ], "type": "string", "description": "Metric threshold condition type." }, "MetricThresholdRule": { "title": "Metric Threshold Rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/MetricThresholdCondition" } ], "description": "The condition for the metric threshold alert" }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "Alert override settings" } }, "description": "Defines a rule for metric-based threshold alerts" }, "MetricThresholdType": { "title": "Metric-based threshold alert type", "type": "object", "properties": { "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the alert condition", "examples": [ 60000 ], "format": "int32", "maximum": 10800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "metricFilter": { "allOf": [ { "$ref": "#/components/schemas/MetricFilter" } ], "description": "The filter to match metric entries for the alert." }, "missingValues": { "allOf": [ { "$ref": "#/components/schemas/MetricMissingValues" } ], "description": "Configuration for handling missing values in the alert." }, "noDataPolicy": { "allOf": [ { "$ref": "#/components/schemas/NoDataPolicy" } ], "description": "User configuration to decide how to treat and what state to give to an alert with no data." }, "rules": { "maxItems": 5, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/MetricThresholdRule" }, "description": "The rules for the metric threshold alert" }, "undetectedValuesManagement": { "allOf": [ { "$ref": "#/components/schemas/v3.UndetectedValuesManagement" } ], "description": "Configuration for handling undetected values in the alert." } }, "description": "Configuration for alerts based on metric threshold violations", "externalDocs": { "description": "Learn more about metric-based threshold alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/metrics/threshold-alerts/" } }, "MetricTimeWindow": { "title": "Metric time window", "type": "object", "oneOf": [ { "required": [ "metricTimeWindowSpecificValue" ], "type": "object" }, { "required": [ "metricTimeWindowDynamicDuration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metricTimeWindowSpecificValue" ], "type": "object" }, { "required": [ "metricTimeWindowDynamicDuration" ], "type": "object" } ] } } ], "properties": { "metricTimeWindowDynamicDuration": { "description": "The time window as a dynamic value", "examples": [ "1h30m" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "metricTimeWindowSpecificValue": { "allOf": [ { "$ref": "#/components/schemas/MetricTimeWindowValue" } ], "description": "The time window as a specific value", "examples": [ "METRIC_TIME_WINDOW_VALUE_MINUTES_5" ] } }, "description": "Metric time window." }, "MetricTimeWindowValue": { "enum": [ "METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED", "METRIC_TIME_WINDOW_VALUE_MINUTES_5", "METRIC_TIME_WINDOW_VALUE_MINUTES_10", "METRIC_TIME_WINDOW_VALUE_MINUTES_15", "METRIC_TIME_WINDOW_VALUE_MINUTES_20", "METRIC_TIME_WINDOW_VALUE_MINUTES_30", "METRIC_TIME_WINDOW_VALUE_HOUR_1", "METRIC_TIME_WINDOW_VALUE_HOURS_2", "METRIC_TIME_WINDOW_VALUE_HOURS_4", "METRIC_TIME_WINDOW_VALUE_HOURS_6", "METRIC_TIME_WINDOW_VALUE_HOURS_12", "METRIC_TIME_WINDOW_VALUE_HOURS_24", "METRIC_TIME_WINDOW_VALUE_HOURS_36" ], "type": "string", "description": "Metric time window value." }, "Metrics": { "title": "MetricsQuery", "type": "object", "properties": { "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder based", "examples": [ "2" ] }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "seriesLimitType": { "allOf": [ { "$ref": "#/components/schemas/MetricsSeriesLimitType" } ], "description": "How to limit the result using series_count_limit parameter", "examples": [ "1" ] } }, "description": "A metrics variant of the query" }, "MetricsFilter": { "title": "MetricsFilter", "type": "object", "properties": { "label": { "description": "The label associated with the metric.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "metric": { "description": "The name of the metric to which the filter is applied.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "operator": { "allOf": [ { "$ref": "#/components/schemas/Filter.Operator" } ], "description": "An operator used for filtering the metrics." } } }, "MetricsQueryEditorMode": { "enum": [ "METRICS_QUERY_EDITOR_MODE_UNSPECIFIED", "METRICS_QUERY_EDITOR_MODE_TEXT", "METRICS_QUERY_EDITOR_MODE_BUILDER" ], "type": "string", "description": "Metrics query editor mode." }, "MetricsSeriesLimitType": { "enum": [ "METRICS_SERIES_LIMIT_TYPE_UNSPECIFIED", "METRICS_SERIES_LIMIT_TYPE_BY_SERIES_COUNT", "METRICS_SERIES_LIMIT_TYPE_BY_POINT_COUNT" ], "type": "string", "description": "Metrics series limit type." }, "MetricsSource": { "type": "object", "properties": { "intervalResolution": { "$ref": "#/components/schemas/IntervalResolution" }, "labels": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of labels." }, "description": "List of labels." }, "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "orientation": { "$ref": "#/components/schemas/AnnotationOrientation" }, "promqlQuery": { "$ref": "#/components/schemas/PromQlQuery" }, "strategy": { "$ref": "#/components/schemas/MetricsSource.Strategy" } }, "description": "Annotation source backed by a PromQL metrics query with a configurable time strategy." }, "MetricsSource.Strategy": { "type": "object", "properties": { "startTimeMetric": { "$ref": "#/components/schemas/StartTimeMetric" } }, "description": "Dataprime source.strategy." }, "MicrosoftTeams": { "title": "Microsoft Teams resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved through a Microsoft Teams integration." }, "MicrosoftTeamsActor": { "title": "Microsoft Teams actor", "type": "object", "properties": { "coralogixUserId": { "description": "If the Microsoft Teams user is linked to a Coralogix user, this field contains the Coralogix user ID.", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ], "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", "x-coralogix-presence": true }, "displayName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams display name", "examples": [ "John Doe" ] }, "teamsUserId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams user ID", "examples": [ "29:1abc123def456" ] }, "userEmail": { "description": "Email of the Microsoft Teams user", "examples": [ "john.doe@example.com" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Information about the Microsoft Teams user who initiated the action." }, "MicrosoftTeamsCommentMetadata": { "title": "Microsoft Teams comment metadata", "type": "object", "properties": { "channelId": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams channel ID", "examples": [ "19:0123456789abcdef0123456789abcdef@thread.tacv2" ] }, "messageId": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams message ID", "examples": [ "1616990892312" ] }, "messageUrl": { "description": "Deep link URL to the Microsoft Teams message", "examples": [ "https://teams.microsoft.com/l/message/19:abcdef@thread.tacv2/1616990892312" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "teamId": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams team ID", "examples": [ "19:abcdef1234567890abcdef1234567890@thread.tacv2" ] }, "tenantId": { "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": "Microsoft Teams tenant ID", "examples": [ "72f988bf-86f1-41af-91ab-2d7cd011db47" ] }, "userEmail": { "description": "Email of the Microsoft Teams user", "examples": [ "john.doe@example.com" ], "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "userId": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Microsoft Teams user ID", "examples": [ "29:1IqRc0iDN0jXaDs0zc5j9dEcLpFXKh9sHg" ] } }, "description": "Microsoft Teams source metadata attached to a comment that was synced from Microsoft Teams." }, "MicrosoftTeamsConfig": { "title": "Microsoft Teams configuration", "type": "object", "additionalProperties": false, "description": "Microsoft teams config." }, "Min": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Min." }, "MinMax": { "title": "Min-Max", "type": "object", "oneOf": [ { "required": [ "auto" ], "type": "object" }, { "required": [ "custom" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "auto" ], "type": "object" }, { "required": [ "custom" ], "type": "object" } ] } } ], "properties": { "auto": { "allOf": [ { "$ref": "#/components/schemas/MinMaxAuto" } ], "description": "An empty value to determine min/max limits to be automatically derived from data" }, "custom": { "allOf": [ { "$ref": "#/components/schemas/MinMaxCustom" } ], "description": "Define min and/or max limits with custom values to affect widget scaling and/or colors" } }, "description": "Definition of min/max value configuration, can be automatically derived from data or custom" }, "MinMaxAuto": { "type": "object", "additionalProperties": false, "description": "Min max auto." }, "MinMaxCustom": { "type": "object", "properties": { "max": { "description": "Maximum value.", "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "Minimum value.", "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Min max custom." }, "MissingDataStrategy": { "enum": [ "MISSING_DATA_STRATEGY_UNCOUNTED", "MISSING_DATA_STRATEGY_GOOD", "MISSING_DATA_STRATEGY_BAD" ], "type": "string", "description": "Missing data strategy." }, "ModelPrice": { "type": "object", "properties": { "cacheReadPricePerMillionTokens": { "type": "number", "description": "Cache read token price per one million tokens (USD).", "format": "double" }, "cacheWritePricePerMillionTokens": { "type": "number", "description": "Cache write token price per one million tokens (USD).", "format": "double" }, "inputPricePerMillionTokens": { "type": "number", "description": "Input token price per one million tokens (USD).", "format": "double" }, "outputPricePerMillionTokens": { "type": "number", "description": "Output token price per one million tokens (USD).", "format": "double" } }, "description": "Custom price for a single model, per one million tokens (USD)." }, "Monthly": { "required": [ "daysOfMonth" ], "type": "object", "properties": { "daysOfMonth": { "description": "The days of month.", "items": { "type": "integer", "description": "The days of month.", "format": "int32" }, "minItems": 1, "type": "array", "x-coralogix-collection": "set" } }, "description": "Monthly." }, "MultiSelect": { "type": "object", "properties": { "selected": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The selected values.", "deprecated": true }, "description": "The selected values.", "deprecated": true }, "selection": { "$ref": "#/components/schemas/MultiSelect.Selection" }, "selectionOptions": { "$ref": "#/components/schemas/VariableSelectionOptions" }, "source": { "$ref": "#/components/schemas/MultiSelect.Source" }, "valuesOrderDirection": { "$ref": "#/components/schemas/OrderDirection" } }, "description": "A dashboard variable that allows selecting one or more values from a dynamically or statically populated list." }, "MultiSelect.Query": { "type": "object", "oneOf": [ { "required": [ "logsQuery" ], "type": "object" }, { "required": [ "metricsQuery" ], "type": "object" }, { "required": [ "spansQuery" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logsQuery" ], "type": "object" }, { "required": [ "metricsQuery" ], "type": "object" }, { "required": [ "spansQuery" ], "type": "object" } ] } } ], "properties": { "logsQuery": { "$ref": "#/components/schemas/Query.LogsQuery" }, "metricsQuery": { "$ref": "#/components/schemas/Query.MetricsQuery" }, "spansQuery": { "$ref": "#/components/schemas/Query.SpansQuery" } }, "description": "Discriminated union specifying whether to query logs, metrics, or spans for variable values." }, "MultiSelect.QuerySource": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/MultiSelect.Query" }, "refreshStrategy": { "$ref": "#/components/schemas/MultiSelect.RefreshStrategy" }, "valueDisplayOptions": { "$ref": "#/components/schemas/MultiSelect.ValueDisplayOptions" } }, "description": "Variable source that populates multi-select values by executing a query against logs, metrics, or spans." }, "MultiSelect.RefreshStrategy": { "enum": [ "REFRESH_STRATEGY_UNSPECIFIED", "REFRESH_STRATEGY_ON_DASHBOARD_LOAD", "REFRESH_STRATEGY_ON_TIME_FRAME_CHANGE" ], "type": "string", "description": "Refresh strategy." }, "MultiSelect.Selection": { "type": "object", "oneOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" } ] } } ], "properties": { "all": { "$ref": "#/components/schemas/MultiSelect.Selection.AllSelection" }, "list": { "$ref": "#/components/schemas/MultiSelect.Selection.ListSelection" } }, "description": "Discriminated union defining the current selection state: all values or a specific list of values." }, "MultiSelect.Selection.AllSelection": { "type": "object", "additionalProperties": false, "description": "All selection." }, "MultiSelect.Selection.ListSelection": { "type": "object", "properties": { "labels": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of labels." }, "description": "List of labels." }, "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of values." }, "description": "List of values." } }, "description": "A list-based selection specifying the currently selected values and their display labels." }, "MultiSelect.Source": { "type": "object", "oneOf": [ { "required": [ "logsPath" ], "type": "object" }, { "required": [ "metricLabel" ], "type": "object" }, { "required": [ "constantList" ], "type": "object" }, { "required": [ "spanField" ], "type": "object" }, { "required": [ "query" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logsPath" ], "type": "object" }, { "required": [ "metricLabel" ], "type": "object" }, { "required": [ "constantList" ], "type": "object" }, { "required": [ "spanField" ], "type": "object" }, { "required": [ "query" ], "type": "object" } ] } } ], "properties": { "constantList": { "$ref": "#/components/schemas/ConstantListSource" }, "logsPath": { "$ref": "#/components/schemas/LogsPathSource" }, "metricLabel": { "$ref": "#/components/schemas/MetricLabelSource" }, "query": { "$ref": "#/components/schemas/MultiSelect.QuerySource" }, "spanField": { "$ref": "#/components/schemas/SpanFieldSource" } }, "description": "Source." }, "MultiSelect.ValueDisplayOptions": { "type": "object", "properties": { "labelRegex": { "description": "The label regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "valueRegex": { "description": "The value regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Value display options." }, "MultiStringValue": { "type": "object", "oneOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" }, { "required": [ "selectedAll" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "all" ], "type": "object" }, { "required": [ "list" ], "type": "object" }, { "required": [ "selectedAll" ], "type": "object" } ] } } ], "properties": { "all": { "$ref": "#/components/schemas/AllValue" }, "list": { "$ref": "#/components/schemas/ListValue" }, "selectedAll": { "$ref": "#/components/schemas/SelectedAllValue" } }, "description": "A variable value representing multiple selected string values: all, a specific list, or selected-all." }, "MultipleSelectionValue": { "title": "Multiple selection value", "type": "object", "properties": { "options": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Options." }, "description": "Options." } }, "description": "Multiple selection value." }, "MultipleValues": { "type": "object", "properties": { "matcher": { "$ref": "#/components/schemas/events.v3.FilterMatcher" }, "values": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string" } } } }, "NextOp": { "enum": [ "NEXT_OP_AND_OR_UNSPECIFIED", "NEXT_OP_OR" ], "type": "string", "description": "Next op." }, "NoConnector": { "type": "object", "additionalProperties": false, "description": "No connector." }, "NoDataPolicy": { "type": "object", "properties": { "autoRetireSeconds": { "description": "The timeframe in seconds for auto retiring values that were detected as no-data. accepts only multiples of 60 seconds", "examples": [ 3600 ], "format": "int32", "minimum": 60, "type": "integer", "x-coralogix-presence": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/NoDataPolicyState" } ], "description": "The state to which the alert falls back to when theres no data (replaces UndetectedValuesManagement - this feature is being released gradually and might not be available for all customers yet)", "examples": [ "NO_DATA_POLICY_STATE_ALERTING" ] } }, "description": "No data policy." }, "NoDataPolicyState": { "enum": [ "NO_DATA_POLICY_STATE_UNSPECIFIED", "NO_DATA_POLICY_STATE_OK", "NO_DATA_POLICY_STATE_ALERTING", "NO_DATA_POLICY_STATE_KEEP_LAST", "NO_DATA_POLICY_STATE_NO_DATA" ], "type": "string", "description": "No data policy state." }, "NoDeployment": { "title": "No deployment", "type": "object", "additionalProperties": false }, "NoNotificationCreatedResult": { "title": "No notification created result", "required": [ "matchedRouters" ], "type": "object", "properties": { "matchedRouters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RouterInfo" }, "description": "Routers that matched the notification request" } }, "description": "Indicates that routers matched but no notification was ultimately created." }, "NoRouterMatchedResult": { "title": "No router matched result", "type": "object", "additionalProperties": false, "description": "Indicates that no router matched the notification request." }, "NotEquals.Selection": { "title": "Selection", "type": "object", "properties": { "list": { "allOf": [ { "$ref": "#/components/schemas/NotEquals.Selection.ListSelection" } ], "description": "Represents a selection from a list of values." } } }, "NotEquals.Selection.ListSelection": { "title": "ListSelection", "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "A list of values for the selection." }, "description": "A list of values for the selection." } } }, "NotificationDelivery": { "title": "Notification delivery", "required": [ "timestamp" ], "type": "object", "oneOf": [ { "required": [ "noRouterMatched" ], "type": "object" }, { "required": [ "noNotificationCreated" ], "type": "object" }, { "required": [ "attempted" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "noRouterMatched" ], "type": "object" }, { "required": [ "noNotificationCreated" ], "type": "object" }, { "required": [ "attempted" ], "type": "object" } ] } } ], "properties": { "attempted": { "allOf": [ { "$ref": "#/components/schemas/RoutedDelivery" } ], "description": "Delivery was attempted through a router to one or more connectors" }, "noNotificationCreated": { "allOf": [ { "$ref": "#/components/schemas/NoNotificationCreatedResult" } ], "description": "Routers matched but no notification was created" }, "noRouterMatched": { "allOf": [ { "$ref": "#/components/schemas/NoRouterMatchedResult" } ], "description": "No router matched the notification request" }, "requestNotificationId": { "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 notification request ID that triggered this delivery, used to correlate delivery outcomes with their originating requests", "examples": [ "a1b2c3d4-5678-90ab-cdef-1234567890ab" ] }, "timestamp": { "description": "When the notification was triggered", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Delivery results for a single notification." }, "NotificationDestination": { "title": "Notification destination configuration", "type": "object", "properties": { "connectorId": { "minLength": 0, "type": "string", "description": "The connector ID used to send notifications", "examples": [ "connector_id_example" ] }, "notifyOn": { "allOf": [ { "$ref": "#/components/schemas/NotifyOn" } ], "description": "The condition under which the notification should be sent", "examples": [ "NOTIFY_ON_TRIGGERED_AND_RESOLVED" ] }, "presetId": { "description": "Optional preset ID for the notification destination", "examples": [ "preset_id_example" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "resolvedRouteOverrides": { "allOf": [ { "$ref": "#/components/schemas/NotificationRouting" } ], "description": "Optional routing configuration to override from the connector/preset for resolved notifications." }, "retriggeringPeriodMinutes": { "description": "The time in minutes before a new notification is sent for this destination", "examples": [ 600 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "triggeredRoutingOverrides": { "allOf": [ { "$ref": "#/components/schemas/NotificationRouting" } ], "description": "The routing configuration to override from the connector/preset for triggered notifications." } }, "description": "Configuration for where and how alert notifications should be sent", "externalDocs": { "description": "Learn more about alert notification destinations in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/configure-notifications/destinations/" } }, "NotificationFailedCaseEvent": { "title": "Notification failed event", "type": "object", "properties": { "error": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Error message for the failed notification", "examples": [ "Slack API: channel_not_found" ] } }, "description": "Notification failed case event." }, "NotificationMetadata": { "title": "Notification metadata", "type": "object", "properties": { "token": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Notification token/reference", "examples": [ "4c8ba1ec-acee-4bc7-ad6c-d35476b58541" ] } } }, "NotificationRouter": { "title": "Notification router", "type": "object", "properties": { "id": { "description": "The ID of the notification router", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "notifyOn": { "allOf": [ { "$ref": "#/components/schemas/NotifyOn" } ], "description": "The condition under which the notification should be sent", "examples": [ "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED" ], "x-coralogix-presence": true } }, "description": "Configuration for routing notifications" }, "NotificationRouting": { "title": "Notification routing", "type": "object", "properties": { "configOverrides": { "allOf": [ { "$ref": "#/components/schemas/v3.SourceOverrides" } ], "description": "Configuration for routing notifications" } }, "description": "Notification routing." }, "NotificationSentCaseEvent": { "title": "Notification sent event", "type": "object", "properties": { "notificationRequestId": { "description": "The notification request ID, as sent to the notifications center.", "examples": [ "a1b2c3d4-5678-90ab-cdef-1234567890ab" ], "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", "x-coralogix-presence": true }, "notifications": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/NotificationMetadata" }, "description": "List of notifications produced by this action" } }, "description": "Notification sent case event." }, "NotifyOn": { "enum": [ "NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED", "NOTIFY_ON_TRIGGERED_AND_RESOLVED" ], "type": "string", "description": "Notify on." }, "NumericValueLabel": { "type": "object", "properties": { "label": { "description": "The label.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Numeric value label." }, "ObservationField": { "type": "object", "properties": { "keypath": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The keypath." }, "description": "The keypath." }, "scope": { "$ref": "#/components/schemas/DatasetScope" } }, "description": "Observation field." }, "OllyAnalysis": { "title": "Olly analysis", "type": "object", "properties": { "completedAt": { "description": "When the analysis attempt completed.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "payload": { "allOf": [ { "$ref": "#/components/schemas/OllyAnalysisPayload" } ], "description": "Typed analysis payload returned by Olly. Present only when status = STATUS_OK." }, "status": { "allOf": [ { "$ref": "#/components/schemas/OllyAnalysisStatus" } ], "description": "Outcome of the analysis attempt.", "examples": [ "STATUS_OK" ] } }, "description": "Result of an automated Olly analysis attached to a case." }, "OllyAnalysisPayload": { "title": "Olly analysis payload", "type": "object", "properties": { "generatedAt": { "description": "Timestamp when the analysis was generated.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "investigationSummary": { "maxLength": 8192, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Natural-language summary of the Olly investigation.", "examples": [ "Latency spike on checkout-service correlates with a deploy of v1.42 and elevated DB pool saturation." ] }, "remediationRecommendations": { "maxItems": 50, "minItems": 0, "type": "array", "items": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Ordered list of remediation steps, one recommendation per element." }, "description": "Ordered list of remediation steps, one recommendation per element.", "examples": [ [ "Roll back checkout-service to v1.41", "Increase orders Postgres pool size to 200" ] ] }, "rootCause": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Olly's hypothesised root cause for the case.", "examples": [ "Connection-pool exhaustion on the orders Postgres instance." ] }, "rootCauseConfidence": { "allOf": [ { "$ref": "#/components/schemas/OllyAnalysisRootCauseConfidence" } ], "description": "Confidence level Olly assigns to the root-cause hypothesis.", "examples": [ "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_HIGH" ] } }, "description": "Typed analysis payload returned by Olly. Present only when status = STATUS_OK." }, "OllyAnalysisRootCauseConfidence": { "enum": [ "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_UNSPECIFIED", "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_LOW", "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_MEDIUM", "OLLY_ANALYSIS_ROOT_CAUSE_CONFIDENCE_HIGH" ], "type": "string", "description": "Confidence level Olly assigns to the root-cause hypothesis." }, "OllyAnalysisStatus": { "enum": [ "STATUS_UNSPECIFIED", "STATUS_OK", "STATUS_CAPACITY_REACHED", "STATUS_FAILED" ], "type": "string", "description": "Olly analysis outcome status." }, "OnboardingMode": { "enum": [ "ONBOARDING_MODE_UNSPECIFIED", "ONBOARDING_MODE_INVITE_LINK", "ONBOARDING_MODE_NO_INVITE" ], "type": "string", "description": "Onboarding mode." }, "OneTime": { "required": [ "timeframe" ], "type": "object", "properties": { "timeframe": { "$ref": "#/components/schemas/Timeframe" } }, "description": "One time." }, "OpsgenieConfig": { "title": "Opsgenie configuration", "type": "object", "additionalProperties": false, "description": "Opsgenie config." }, "OrderActionsResponse": { "type": "object", "additionalProperties": false }, "OrderByAlertEventDirection": { "enum": [ "ORDER_BY_ALERT_EVENT_DIRECTION_UNSPECIFIED", "ORDER_BY_ALERT_EVENT_DIRECTION_ASC", "ORDER_BY_ALERT_EVENT_DIRECTION_DESC" ], "type": "string", "description": "Order by alert event direction." }, "OrderByAlertEventFields": { "enum": [ "ORDER_BY_ALERT_EVENT_FIELDS_UNSPECIFIED", "ORDER_BY_ALERT_EVENT_FIELDS_TIMESTAMP" ], "type": "string", "description": "Order by alert event fields." }, "OrderDirection": { "enum": [ "ORDER_DIRECTION_UNSPECIFIED", "ORDER_DIRECTION_ASC", "ORDER_DIRECTION_DESC", "ORDER_DIRECTION_NONE" ], "type": "string", "description": "Order direction." }, "OrderingField": { "type": "object", "properties": { "field": { "description": "Field name to order by", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "orderDirection": { "allOf": [ { "$ref": "#/components/schemas/OrderDirection" } ], "description": "Order direction, ascending or descending", "examples": [ "1" ] } }, "description": "Ordering field." }, "OriginatorType": { "enum": [ "ORIGINATOR_TYPE_UNSPECIFIED", "ORIGINATOR_TYPE_OPERATIONAL", "ORIGINATOR_TYPE_ADMINISTRATIVE" ], "type": "string", "description": "Originator type." }, "OutRule": { "title": "Out Rule", "required": [ "record", "expr", "labels" ], "type": "object", "properties": { "evaluationDelayMs": { "description": "The delay in milliseconds before evaluating the recording rule expression. Allows late-arriving data to be ingested before evaluation. An omitted delay stays omitted, and 0 is stored as 0.", "format": "int64", "maximum": 1800000, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "expr": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The PromQL expression to evaluate. Every evaluation cycle evaluates it at the current time and records the result as a new set of time series with the metric name of `record`." }, "labels": { "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Labels to add or overwrite before storing the result. An omitted map is stored as an empty map." }, "lastEvalDurationMs": { "description": "The last eval duration ms.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "record": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name of the time series to output to. Must be a valid metric name." } }, "description": "A recording rule as returned by the API.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "OutRuleGroup": { "title": "Out Rule Group", "required": [ "name", "interval", "limit", "rules", "version", "id" ], "type": "object", "properties": { "id": { "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Unique identifier." }, "interval": { "default": 60, "description": "How often the rules of the group are evaluated, in seconds. At least 60. An omitted interval is stored as 60, also on an update.", "format": "int64", "maximum": 4294967295, "minimum": 60, "type": "integer", "x-coralogix-presence": true }, "lastEvalAt": { "description": "The last eval at.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "limit": { "default": "0", "description": "Limits the number of series that a rule of the group can produce. 0 means no limit. An omitted limit is stored as 0, also on an update.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name of the group. Unique within the set." }, "rules": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutRule" }, "description": "List of rules." }, "version": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Version number.", "format": "int64" } }, "description": "A group of recording rules as returned by the API.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "OutRuleGroupSet": { "title": "Out Rule Group Set", "required": [ "id", "groups", "name" ], "type": "object", "properties": { "groups": { "description": "The rule groups of the set, in no particular order.", "items": { "$ref": "#/components/schemas/OutRuleGroup" }, "maxItems": 1000, "minItems": 0, "type": "array", "x-coralogix-collection": "set" }, "id": { "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Unique identifier." }, "name": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The name of the set. Unique among the sets of the company." } }, "description": "An output set of rule groups.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "OutboundWebhookSummary": { "title": "Outbound webhook summary", "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "The external id.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/WebhookType" }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "OutgoingWebhook": { "title": "Outgoing webhook", "required": [ "id", "type", "name", "createdAt", "updatedAt", "externalId" ], "type": "object", "oneOf": [ { "required": [ "genericWebhook" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "sendLog" ], "type": "object" }, { "required": [ "emailGroup" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" }, { "required": [ "jira" ], "type": "object" }, { "required": [ "opsgenie" ], "type": "object" }, { "required": [ "demisto" ], "type": "object" }, { "required": [ "awsEventBridge" ], "type": "object" }, { "required": [ "ibmEventNotifications" ], "type": "object" }, { "required": [ "msTeamsWorkflow" ], "type": "object" } ], "properties": { "awsEventBridge": { "$ref": "#/components/schemas/AwsEventBridgeConfig" }, "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "demisto": { "$ref": "#/components/schemas/DemistoConfig" }, "emailGroup": { "$ref": "#/components/schemas/EmailGroupConfig" }, "externalId": { "description": "External identifier.", "examples": [ 123456 ], "format": "int64", "minimum": 0, "readOnly": true, "type": "integer", "x-coralogix-presence": true }, "genericWebhook": { "$ref": "#/components/schemas/GenericWebhookConfig" }, "ibmEventNotifications": { "$ref": "#/components/schemas/IbmEventNotificationsConfig" }, "id": { "description": "Unique identifier.", "examples": [ "webhook_id" ], "minLength": 1, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "jira": { "$ref": "#/components/schemas/JiraConfig" }, "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeamsConfig" }, "msTeamsWorkflow": { "$ref": "#/components/schemas/MSTeamsWorkflowConfig" }, "name": { "description": "Display name.", "examples": [ "my_webhook" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "opsgenie": { "$ref": "#/components/schemas/OpsgenieConfig" }, "pagerDuty": { "$ref": "#/components/schemas/PagerDutyConfig" }, "sendLog": { "$ref": "#/components/schemas/SendLogConfig" }, "slack": { "$ref": "#/components/schemas/SlackConfig" }, "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "readOnly": true, "examples": [ "1" ] }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "url": { "description": "URL.", "examples": [ "slack.webhook.com" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Outgoing webhook." }, "OutgoingWebhookDetails": { "title": "Outgoing webhook details", "type": "object", "properties": { "label": { "description": "The label.", "examples": [ "example_label" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/WebhookType" } }, "description": "Outgoing webhook details." }, "OutgoingWebhookExtendedSummary": { "title": "Outgoing webhook extended summary", "required": [ "id", "type", "name", "createdAt", "updatedAt", "externalId" ], "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "External identifier.", "examples": [ 123456 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "examples": [ "webhook_id" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "examples": [ "my_webhook" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "examples": [ "1" ] }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "url": { "description": "URL.", "examples": [ "slack.webhook.com" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "OutgoingWebhookInputData": { "title": "Outgoing webhook input data", "required": [ "name" ], "type": "object", "oneOf": [ { "required": [ "genericWebhook" ], "type": "object" }, { "required": [ "slack" ], "type": "object" }, { "required": [ "pagerDuty" ], "type": "object" }, { "required": [ "sendLog" ], "type": "object" }, { "required": [ "emailGroup" ], "type": "object" }, { "required": [ "microsoftTeams" ], "type": "object" }, { "required": [ "jira" ], "type": "object" }, { "required": [ "opsgenie" ], "type": "object" }, { "required": [ "demisto" ], "type": "object" }, { "required": [ "awsEventBridge" ], "type": "object" }, { "required": [ "ibmEventNotifications" ], "type": "object" }, { "required": [ "msTeamsWorkflow" ], "type": "object" } ], "properties": { "awsEventBridge": { "$ref": "#/components/schemas/AwsEventBridgeConfig" }, "demisto": { "$ref": "#/components/schemas/DemistoConfig" }, "emailGroup": { "$ref": "#/components/schemas/EmailGroupConfig" }, "genericWebhook": { "$ref": "#/components/schemas/GenericWebhookConfig" }, "ibmEventNotifications": { "$ref": "#/components/schemas/IbmEventNotificationsConfig" }, "jira": { "$ref": "#/components/schemas/JiraConfig" }, "microsoftTeams": { "$ref": "#/components/schemas/MicrosoftTeamsConfig" }, "msTeamsWorkflow": { "$ref": "#/components/schemas/MSTeamsWorkflowConfig" }, "name": { "description": "Display name.", "examples": [ "my_webhook" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "opsgenie": { "$ref": "#/components/schemas/OpsgenieConfig" }, "pagerDuty": { "$ref": "#/components/schemas/PagerDutyConfig" }, "sendLog": { "$ref": "#/components/schemas/SendLogConfig" }, "slack": { "$ref": "#/components/schemas/SlackConfig" }, "type": { "allOf": [ { "$ref": "#/components/schemas/WebhookType" } ], "readOnly": true, "examples": [ "1" ] }, "url": { "description": "URL.", "examples": [ "slack.webhook.com" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Outgoing webhook input data. The selected config determines the type. A URL is required for Generic, Slack, Microsoft Teams workflow, Jira, Opsgenie, and Demisto webhooks. Microsoft Teams writes are rejected because this type is deprecated. Send Log needs no URL. A service policy may reject a supplied Send Log URL. An update replaces the config and cannot change the webhook type." }, "OutgoingWebhookSummary": { "title": "Outgoing webhook summary", "required": [ "id", "name", "createdAt", "updatedAt", "externalId" ], "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "External identifier.", "examples": [ 123456 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "examples": [ "webhook_id" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name.", "examples": [ "my_webhook" ], "minLength": 1, "type": "string", "x-coralogix-presence": true }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "url": { "description": "URL.", "examples": [ "slack.webhook.com" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "OutgoingWebhookType": { "title": "Outgoing webhook type", "type": "object", "properties": { "count": { "description": "Number of items.", "examples": [ 3 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "label": { "description": "The label.", "examples": [ "example_label" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/WebhookType" } } }, "Owner": { "type": "object", "oneOf": [ { "required": [ "userId" ], "type": "object" }, { "required": [ "teamId" ], "type": "object" }, { "required": [ "organisationId" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "userId" ], "type": "object" }, { "required": [ "teamId" ], "type": "object" }, { "required": [ "organisationId" ], "type": "object" } ] } } ], "properties": { "organisationId": { "minLength": 0, "type": "string", "description": "Organisation identifier of the API key owner." }, "teamId": { "minimum": 0, "type": "integer", "description": "The team id.", "format": "int64" }, "userId": { "minLength": 0, "type": "string", "description": "User identifier of the API key owner." } }, "description": "Owner." }, "PagerDuty": { "title": "PagerDuty resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved through a PagerDuty integration." }, "PagerDutyActor": { "title": "PagerDuty actor", "type": "object", "properties": { "coralogixUserId": { "description": "If the PagerDuty user is linked to a Coralogix user, this field contains the Coralogix user ID.", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ], "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", "x-coralogix-presence": true }, "displayName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "PagerDuty display name", "examples": [ "John Doe" ] }, "pagerDutyUserId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "PagerDuty user ID", "examples": [ "U012AB3CD" ] }, "userEmail": { "description": "Email of the PagerDuty user", "examples": [ "john.doe@example.com" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Information about the PagerDuty user who initiated the action." }, "PagerDutyConfig": { "title": "PagerDuty configuration", "required": [ "serviceKey" ], "type": "object", "properties": { "serviceKey": { "description": "Service key. Required on Create and Update. Treat any value returned by Get as a secret.", "examples": [ "pager_duty_service_key" ], "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Pager duty config." }, "Parameter": { "title": "Parameter", "type": "object", "oneOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "booleanValue" ], "type": "object" }, { "required": [ "stringList" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "numericValue" ], "type": "object" }, { "required": [ "sensitiveData" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "booleanValue" ], "type": "object" }, { "required": [ "stringList" ], "type": "object" }, { "required": [ "apiKey" ], "type": "object" }, { "required": [ "numericValue" ], "type": "object" }, { "required": [ "sensitiveData" ], "type": "object" } ] } } ], "properties": { "apiKey": { "$ref": "#/components/schemas/ApiKeyData" }, "booleanValue": { "description": "Boolean value for this integration parameter.", "type": "boolean", "x-coralogix-presence": true }, "key": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The key." }, "numericValue": { "description": "Numeric value for this integration parameter.", "format": "double", "type": "number", "x-coralogix-presence": true }, "sensitiveData": { "$ref": "#/components/schemas/SensitiveDataPlaceholder" }, "stringList": { "$ref": "#/components/schemas/StringList" }, "stringValue": { "description": "String value for this integration parameter.", "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "ParseParameters": { "required": [ "rule", "destinationField" ], "type": "object", "properties": { "destinationField": { "description": "The field that receives the result. An empty string writes to the source field.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "rule": { "description": "The regular expression, with named capture groups, applied to the source field. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Parse parameters. Parses the source field with a regular expression and writes the named capture groups to the destination field." }, "Percentile": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" }, "percent": { "description": "The percent.", "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Percentile." }, "PermanentAccess": { "title": "PermanentAccess", "type": "object", "additionalProperties": false, "description": "User with permanent access. The user's access does not expire and remains active until manually revoked or deactivated." }, "PermissionResource": { "enum": [ "UNKNOWN", "ACTION", "ALERT", "CUSTOM_ENRICHMENT", "GEO_ENRICHMENT", "SECURITY_ENRICHMENT", "RESOURCE_CLOUD_METADATA_ENRICHMENT", "GRAFANA_DASHBOARD", "KIBANA_DASHBOARD", "PARSING_RULE", "SAVED_VIEW", "CX_CUSTOM_DASHBOARD", "METRICS_RULE_GROUP", "SPAN_EVENTS_TO_METRICS", "LOGS_EVENTS_TO_METRICS" ], "type": "string", "description": "Permission resource." }, "PermissionsPreset": { "title": "Permissions Preset", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier.", "format": "int32", "examples": [ 1 ] }, "name": { "minLength": 0, "type": "string", "description": "Display name.", "examples": [ "my_preset" ] }, "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions.", "examples": [ "logs:read" ] }, "description": "List of permissions." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "PieChart.DataprimeQuery": { "title": "DataprimeQuery", "type": "object", "properties": { "dataprimeQuery": { "allOf": [ { "$ref": "#/components/schemas/common.DataprimeQuery" } ], "description": "Dataprime query text" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.Source" }, "description": "List of query filters" }, "groupNames": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which results are grouped" }, "description": "List of field names by which results are grouped" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A Dataprime variant of the query" }, "PieChart.LogsQuery": { "title": "LogsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/LogsAggregation" } ], "description": "Query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Filter.LogsFilter" }, "description": "List of filters that narrow down query results" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names to group the query results" }, "description": "List of field names to group the query results" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields to group the results" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search logs" }, "stackedGroupName": { "description": "Field name by which results are stacked in individual group", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Observation field by results are stacked in a group" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the results should be returned" } }, "description": "A logs variant of the query" }, "PieChart.MetricsQuery": { "title": "MetricsQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/common.Aggregation" } ], "description": "Aggregation function" }, "editorMode": { "allOf": [ { "$ref": "#/components/schemas/MetricsQueryEditorMode" } ], "description": "Type of the query editor used to generate the query, can be text or builder mode", "examples": [ "1" ] }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MetricsFilter" }, "description": "List of metrics filters" }, "groupNames": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "List of field names by which metric results are grouped" }, "description": "List of field names by which metric results are grouped" }, "promqlQuery": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string for querying metrics" }, "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Type of the PromQL query, can be Range or Instant" }, "stackedGroupName": { "description": "Field name by which results in groups are divided into subgroups", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the result should be returned" } }, "description": "A metrics variant of the query" }, "PieChart.Query": { "type": "object", "oneOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logs" ], "type": "object" }, { "required": [ "spans" ], "type": "object" }, { "required": [ "metrics" ], "type": "object" }, { "required": [ "dataprime" ], "type": "object" } ] } } ], "properties": { "dataprime": { "$ref": "#/components/schemas/PieChart.DataprimeQuery" }, "logs": { "$ref": "#/components/schemas/PieChart.LogsQuery" }, "metrics": { "$ref": "#/components/schemas/PieChart.MetricsQuery" }, "spans": { "$ref": "#/components/schemas/PieChart.SpansQuery" } }, "description": "Discriminated union of possible query types for the pie chart widget." }, "PieChart.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Span query aggregation function" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupNamesFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields definitions to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "A Lucene query string to search span records" }, "stackedGroupName": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "Field name by which results are stacked in individual group" }, "stackedGroupNameField": { "allOf": [ { "$ref": "#/components/schemas/SpanObservationField" } ], "description": "Observation field definition by which groups are divided into subgroups" }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Specifies the time period for which the records should be returned" } }, "description": "A spans variant of the query" }, "PieChart.StackDefinition": { "type": "object", "properties": { "maxSlicesPerStack": { "description": "How many slices can fit in a single slice stack", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "stackNameTemplate": { "description": "Custom template name of an individual slice in the stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Configuration of stacked slices in the pie chart, including max slices and naming template." }, "PiiCategory": { "enum": [ "PHONE_NUMBER", "EMAIL_ADDRESS", "CREDIT_CARD", "IBAN_CODE", "US_SSN" ], "type": "string" }, "PiiConfig": { "required": [ "categories" ], "type": "object", "properties": { "categories": { "description": "PII categories to detect.", "items": { "$ref": "#/components/schemas/PiiCategory" }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the PII evaluation." }, "PinDashboardResponse": { "title": "Pin dashboard response data structure", "type": "object", "additionalProperties": false, "description": "This is a response received on successful pinning of the dashboard", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "Placement": { "type": "object", "oneOf": [ { "required": [ "first" ], "type": "object" }, { "required": [ "last" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "first" ], "type": "object" }, { "required": [ "last" ], "type": "object" } ] } } ], "properties": { "first": { "$ref": "#/components/schemas/First" }, "last": { "$ref": "#/components/schemas/Last" } }, "description": "Placement." }, "Policy": { "title": "Policy", "required": [ "id", "companyId", "name", "priority", "deleted", "enabled", "order" ], "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" }, "companyId": { "description": "Internal Coralogix company/team identifier that owns this policy.", "examples": [ 1234 ], "format": "int32", "maximum": 2147483647, "minimum": 0, "readOnly": true, "type": "integer", "x-coralogix-presence": true }, "createdAt": { "description": "Timestamp (RFC 3339) when the policy was created.", "examples": [ "2021-01-01T00:00:00.000Z" ], "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "deleted": { "description": "Soft-delete marker; when true the policy has been deleted and is no longer applied.", "examples": [ false ], "readOnly": true, "type": "boolean", "x-coralogix-presence": true }, "description": { "description": "Optional free-text description of the policy's purpose. Only Latin-1 characters are accepted. A policy that `POST /dataplans/policies/v1` created without a description returns an empty string. A policy that an atomic overwrite created without a description can return none.", "examples": [ "My Policy Description" ], "maxLength": 255, "minLength": 0, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Indicates whether the policy is actively evaluated and applied. A create or atomic-overwrite request sets it as the opposite of its `disabled` value; `PUT /dataplans/policies/v1` sets `enabled` directly.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier for the policy. The service sets it, and an overwrite that changes the policies gives every policy a new id.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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}$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "logRules": { "$ref": "#/components/schemas/LogRules" }, "name": { "description": "Human-readable name for the policy. Only Latin-1 characters are accepted.", "examples": [ "My Policy" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\x00-\\xFF]*$", "type": "string", "x-coralogix-presence": true }, "order": { "description": "Ordering priority that determines the sequence in which policies are evaluated. Can be negative for policies placed first. An overwrite sets it to the position of the policy in the request, starting at 1.", "examples": [ 1 ], "format": "int32", "maximum": 2147483647, "minimum": -2147483648, "readOnly": true, "type": "integer", "x-coralogix-presence": true }, "priority": { "$ref": "#/components/schemas/quota.v1.Priority" }, "priorityOverride": { "$ref": "#/components/schemas/PriorityOverride" }, "priorityOverrideStatus": { "allOf": [ { "$ref": "#/components/schemas/PriorityOverrideStatus" } ], "description": "The priority currently in effect, from the quota usage of the team against the usage tiers. Get Company Policies returns it for an enabled policy with a quota-based override.", "readOnly": true }, "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. A log policy created without targets has one target: the `logs` dataset of the `default` dataspace, with the priority and the override of the policy. A span policy has one `spans` target. A RUM policy has none.", "examples": [ [ { "name": "My Target", "dataset": "dataset1", "priority": "PRIORITY_TYPE_HIGH", "archive_retention": { "id": "archive_retention_id" } } ] ] }, "updatedAt": { "description": "Timestamp (RFC 3339) when the policy was last updated.", "examples": [ "2021-01-01T00:00:00.000Z" ], "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true } }, "description": "A policy is a set of rules that define the behavior of the Coralogix system for a specific company.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "PolicyOrder": { "title": "Policy Order", "required": [ "order", "id" ], "type": "object", "properties": { "id": { "description": "Unique identifier.", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "order": { "description": "Sort order. Must be a positive number.", "examples": [ 1 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, "description": "Order of a policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "Preset": { "title": "Preset", "required": [ "name", "connectorType", "entityType" ], "type": "object", "properties": { "attachmentConfig": { "$ref": "#/components/schemas/AttachmentConfig" }, "configOverrides": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConfigOverrides" }, "description": "The config overrides." }, "connectorType": { "$ref": "#/components/schemas/notification_center.ConnectorType" }, "createTime": { "description": "The create time. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "maxLength": 5000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description.", "examples": [ "Custom preset for alerts" ] }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "id": { "description": "Unique identifier.", "examples": [ "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "name": { "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name.", "examples": [ "My Preset" ] }, "parentId": { "description": "The parent id.", "examples": [ "preset_system_slack_alerts_basic" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "presetType": { "allOf": [ { "$ref": "#/components/schemas/PresetType" } ], "description": "Whether the preset is system-provided or custom. Set by the server; a value sent by the client is ignored. Custom presets are stored as CUSTOM.", "readOnly": true, "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true } }, "description": "Set of preconfigured templates for notification content rendering", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "PresetConfigurationFamily": { "required": [ "chartName", "chartVersion", "integrationVersion", "observabilityFeatures", "collectorVersion" ], "type": "object", "properties": { "chartName": { "allOf": [ { "$ref": "#/components/schemas/ChartName" } ], "description": "Configuration template type: CHART_NAME_OTEL_INTEGRATION for Kubernetes, CHART_NAME_OTEL_ECS_EC2 for ECS on EC2, or CHART_NAME_OTEL_LINUX_STANDALONE, CHART_NAME_OTEL_WINDOWS_STANDALONE, or CHART_NAME_OTEL_MACOS_STANDALONE for hosts." }, "chartVersion": { "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": "Configuration template version. It determines the OTel Collector version, the generated collector configuration, and which integrationVersion values are supported. Unsupported versions are rejected." }, "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": "OTel Collector semantic version Coralogix derived from chartVersion, without a leading v prefix.", "examples": [ "0.160.0" ] }, "integrationVersion": { "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": "Version of the observability features format used for this configuration family." }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Environment setup values for the configuration template, such as ClusterName, KubernetesRunningOn, ApplicationName, or SubsystemName. Example: `{\"ClusterName\":\"production-eu2\"}`." }, "observabilityFeatures": { "maxLength": 1048576, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Observability feature settings for the configuration template, as a JSON object string; the available features depend on chartName and integrationVersion. Example: `{\"logs\":{\"enabled\":true}}`." }, "remoteConfigurations": { "maxItems": 128, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RemoteConfiguration" }, "description": "Remote configurations Coralogix generated from the configuration template settings." } }, "description": "Configuration template settings of a configuration family." }, "PresetConfigurationFamilyCreate": { "required": [ "chartName", "chartVersion", "observabilityFeatures" ], "type": "object", "properties": { "chartName": { "allOf": [ { "$ref": "#/components/schemas/ChartName" } ], "description": "Configuration template type: CHART_NAME_OTEL_INTEGRATION for Kubernetes, CHART_NAME_OTEL_ECS_EC2 for ECS on EC2, or CHART_NAME_OTEL_LINUX_STANDALONE, CHART_NAME_OTEL_WINDOWS_STANDALONE, or CHART_NAME_OTEL_MACOS_STANDALONE for hosts." }, "chartVersion": { "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": "Configuration template version. It determines the OTel Collector version, the generated collector configuration, and which integrationVersion values are supported. Unsupported versions are rejected." }, "integrationVersion": { "description": "Version of the observability features format. Omit it to use the default for the template type and version.", "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", "x-coralogix-presence": true }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Environment setup values for the configuration template, such as ClusterName, KubernetesRunningOn, ApplicationName, or SubsystemName. Set the observability features in observabilityFeatures, not under an ObservabilityFeatures key here. Example: `{\"ClusterName\":\"production-eu2\"}`." }, "observabilityFeatures": { "maxLength": 1048576, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Observability feature settings for the configuration template, as a JSON object string; the available features depend on chartName and integrationVersion. Example: `{\"logs\":{\"enabled\":true}}`." } }, "description": "Configuration template settings for a new configuration family; Coralogix generates the remote configurations from them." }, "PresetConfigurationFamilyUpdate": { "type": "object", "properties": { "chartName": { "allOf": [ { "$ref": "#/components/schemas/ChartName" } ], "description": "Configuration template type: CHART_NAME_OTEL_INTEGRATION for Kubernetes, CHART_NAME_OTEL_ECS_EC2 for ECS on EC2, or CHART_NAME_OTEL_LINUX_STANDALONE, CHART_NAME_OTEL_WINDOWS_STANDALONE, or CHART_NAME_OTEL_MACOS_STANDALONE for hosts." }, "chartVersion": { "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": "Configuration template version. It determines the OTel Collector version, the generated collector configuration, and which integrationVersion values are supported. Unsupported versions are rejected." }, "integrationVersion": { "description": "Version of the observability features format. Omit it to use the default for the template type and version.", "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", "x-coralogix-presence": true }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Environment setup values for the configuration template, such as ClusterName, KubernetesRunningOn, ApplicationName, or SubsystemName. Set the observability features in observabilityFeatures, not under an ObservabilityFeatures key here. Example: `{\"ClusterName\":\"production-eu2\"}`." }, "observabilityFeatures": { "maxLength": 1048576, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Observability feature settings for the configuration template, as a JSON object string; the available features depend on chartName and integrationVersion. Example: `{\"logs\":{\"enabled\":true}}`." } }, "description": "Configuration template settings of the latest configuration family. With family.preset in update_mask, chartName, chartVersion, and observabilityFeatures are required and the settings replace the stored ones; omitted metadata is cleared. With a field path, only that field is needed and changes. A new configuration family version is created only when the settings change." }, "PresetConfigurationOverlay": { "required": [ "observabilityFeatures", "targets" ], "type": "object", "properties": { "chartName": { "allOf": [ { "$ref": "#/components/schemas/ChartName" } ], "description": "Preset chart name." }, "observabilityFeatures": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Normalized ObservabilityFeatures JSON." }, "targets": { "description": "Target snapshot of this version.", "items": { "$ref": "#/components/schemas/ConfigurationOverlayTarget" }, "maxItems": 256, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "ObservabilityFeatures preset overlay content of a version." }, "PresetInfo": { "title": "Preset Info", "type": "object", "properties": { "name": { "minLength": 0, "type": "string", "description": "Display name.", "examples": [ "my_preset" ] }, "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions.", "examples": [ "read_logs" ] }, "description": "List of permissions." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "PresetSummary": { "title": "Preset Summary", "type": "object", "properties": { "attachmentConfig": { "$ref": "#/components/schemas/AttachmentConfig" }, "connectorType": { "$ref": "#/components/schemas/notification_center.ConnectorType" }, "createTime": { "description": "The create time.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "maxLength": 5000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable description.", "examples": [ "Custom preset for alerts" ] }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "examples": [ "ALERTS" ] }, "id": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "Unique identifier.", "examples": [ "a16e24c8-4db2-4abf-ba3c-c9e1fc35a3b9" ] }, "name": { "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name.", "examples": [ "My Preset" ] }, "parentId": { "description": "The parent id.", "examples": [ "c246e826-10c2-405e-8d3f-afcc24ad4d15" ], "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true }, "presetType": { "$ref": "#/components/schemas/PresetType" }, "updateTime": { "description": "Timestamp of the last update.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Provides a concise overview of a preset", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "PresetType": { "enum": [ "PRESET_TYPE_UNSPECIFIED", "SYSTEM", "CUSTOM" ], "type": "string", "description": "Preset type." }, "Presets": { "title": "Presets", "type": "object", "properties": { "presets": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Presets." }, "description": "Presets." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "PriorityAggregation": { "title": "Priority aggregation", "type": "object", "properties": { "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases with this priority", "format": "int64", "examples": [ 17 ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Case priority" } }, "description": "Count of cases grouped by case priority." }, "PriorityCount": { "title": "Priority count", "type": "object", "properties": { "count": { "description": "The count for this alert priority", "examples": [ 15 ], "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/AlertDefPriority" } ], "description": "The alert priority", "examples": [ "ALERT_DEF_PRIORITY_P1" ] } }, "description": "Count for a specific alert priority" }, "PriorityDetails": { "title": "Priority details", "type": "object", "properties": { "override": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "Optional override set by user", "x-coralogix-presence": true }, "system": { "allOf": [ { "$ref": "#/components/schemas/CasePriority" } ], "description": "System computed priority" } }, "description": "Priority details, including system computed and user override values." }, "PriorityDetailsChangedCaseEvent": { "title": "Priority details changed event", "type": "object", "properties": { "from": { "allOf": [ { "$ref": "#/components/schemas/PriorityDetails" } ], "description": "Previous priority details" }, "to": { "allOf": [ { "$ref": "#/components/schemas/PriorityDetails" } ], "description": "New priority details" } }, "description": "Priority details changed case event." }, "PriorityOverride": { "type": "object", "properties": { "quotaBased": { "$ref": "#/components/schemas/QuotaBased" } }, "description": "Priority override." }, "PriorityOverrideStatus": { "type": "object", "properties": { "quotaBased": { "$ref": "#/components/schemas/QuotaBasedStatus" } }, "description": "Priority override status." }, "ProductTypeValues": { "type": "object", "properties": { "values": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SloProductType" }, "description": "The values." } }, "description": "Product type values." }, "PromQLQueryType": { "enum": [ "PROM_QL_QUERY_TYPE_UNSPECIFIED", "PROM_QL_QUERY_TYPE_RANGE", "PROM_QL_QUERY_TYPE_INSTANT" ], "type": "string", "description": "Prom ql query type." }, "PromQlQuery": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Prom ql query." }, "PrometheusAlert": { "title": "Prometheus alert", "required": [ "alertGroupId", "alertName", "fingerprint", "priority", "labels", "annotations", "status", "generatorUrl", "createdAt", "updatedAt" ], "type": "object", "properties": { "alertGroupId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Identifier of the Prometheus alerts group this alert belongs to.", "examples": [ "5d41402abc4b2a76b9719d911017c592" ] }, "alertName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the alert (typically the `alertname` label).", "examples": [ "HighRequestLatency" ] }, "annotations": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Annotations attached to the alert." }, "createdAt": { "description": "Timestamp when the alert was first observed.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "fingerprint": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Prometheus alert fingerprint (stable identifier for this alert instance).", "examples": [ "a1b2c3d4e5f6a7b8" ] }, "generatorUrl": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "URL of the system that generated the alert.", "examples": [ "https://prometheus.example.com/graph?g0.expr=..." ] }, "labels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels attached to the alert." }, "priority": { "allOf": [ { "$ref": "#/components/schemas/IndicatorPriority" } ], "description": "Priority of the alert.", "examples": [ "INDICATOR_PRIORITY_P2" ] }, "query": { "allOf": [ { "$ref": "#/components/schemas/PrometheusAlertQuery" } ], "description": "When present, the PromQL query backing the alert." }, "status": { "allOf": [ { "$ref": "#/components/schemas/PrometheusAlertStatus" } ], "description": "Current status of the alert." }, "updatedAt": { "description": "Timestamp when the alert was last updated.", "examples": [ "2025-09-22T11:05:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Data describing a single Prometheus alert within an alert group." }, "PrometheusAlertIndicator": { "title": "Prometheus alert indicator", "required": [ "alertGroupId", "status", "priority", "groupLabels", "receiver", "externalUrl", "receivedAt", "updatedAt", "alerts" ], "type": "object", "properties": { "alertGroupId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Identifier of the Prometheus alerts group.", "examples": [ "5d41402abc4b2a76b9719d911017c592" ] }, "alerts": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PrometheusAlert" }, "description": "Individual alerts contained in this group." }, "externalUrl": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "External URL of the Alertmanager instance that emitted the group.", "examples": [ "https://alertmanager.example.com" ] }, "groupLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels used to group the alerts." }, "priority": { "allOf": [ { "$ref": "#/components/schemas/IndicatorPriority" } ], "description": "Priority of the Prometheus alert group.", "examples": [ "INDICATOR_PRIORITY_P2" ] }, "receivedAt": { "description": "Timestamp when the alert group was first received.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "receiver": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the Alertmanager receiver that handled the group.", "examples": [ "webhook-coralogix" ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/PrometheusAlertStatus" } ], "description": "Current status of the Prometheus alert group." }, "updatedAt": { "description": "Timestamp when the alert group was last updated.", "examples": [ "2025-09-22T11:05:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Data describing a triggered Prometheus alert group and its constituent alerts." }, "PrometheusAlertManager": { "title": "Prometheus AlertManager resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved through a Prometheus AlertManager integration." }, "PrometheusAlertManagerActor": { "title": "Prometheus Alert Manager actor", "type": "object", "properties": { "receiverName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Prometheus Alert Manager receiver name", "examples": [ "alertmanager-main-0" ] } }, "description": "Information about the Prometheus Alert Manager instance that initiated the action." }, "PrometheusAlertManagerIndicator": { "title": "Prometheus AlertManager indicator", "required": [ "fingerprint", "startedAt" ], "type": "object", "properties": { "fingerprint": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Prometheus alert fingerprint — the stable, label-derived hash that identifies this alert across firings.", "examples": [ "a1b2c3d4e5f6a7b8" ] }, "startedAt": { "description": "ISO-8601 timestamp of when the alert episode began (the `startsAt` field from Prometheus AlertManager).", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Lookup keys identifying a specific Prometheus AlertManager alert episode." }, "PrometheusAlertQuery": { "title": "Prometheus alert query", "required": [ "promql" ], "type": "object", "properties": { "promql": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "PromQL expression that triggered the alert.", "examples": [ "histogram_quantile(0.95, rate(http_request_duration_seconds_bucket[5m])) > 1" ] } }, "description": "Query backing a Prometheus alert." }, "PrometheusAlertStatus": { "title": "Prometheus alert status", "type": "object", "oneOf": [ { "required": [ "triggered" ], "type": "object" }, { "required": [ "resolved" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "triggered" ], "type": "object" }, { "required": [ "resolved" ], "type": "object" } ] } } ], "properties": { "resolved": { "$ref": "#/components/schemas/Resolved" }, "triggered": { "$ref": "#/components/schemas/Triggered" } }, "description": "Lifecycle status of a Prometheus alert or alert group." }, "PromptInjectionConfig": { "type": "object", "properties": { "additionalContext": { "maxLength": 65536, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Additional context passed to the LLM evaluator." } }, "description": "Configuration for the PromptInjection evaluation." }, "PromqlQuery": { "type": "object", "properties": { "promqlQueryType": { "allOf": [ { "$ref": "#/components/schemas/PromQLQueryType" } ], "description": "Whether to execute the PromQL query as an instant or a range query. Defaults to instant for variable use cases." }, "query": { "allOf": [ { "$ref": "#/components/schemas/PromQlQuery" } ], "description": "PromQL query string used to fetch the values for this dashboard variable" } }, "description": "Variable query source that executes a PromQL query to populate variable values." }, "Property": { "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/PropertyDefinition" }, "id": { "$ref": "#/components/schemas/UUID" } }, "description": "Property." }, "PropertyDefinition": { "type": "object", "oneOf": [ { "required": [ "thresholds" ], "type": "object" }, { "required": [ "alignment" ], "type": "object" }, { "required": [ "units" ], "type": "object" }, { "required": [ "regexExtract" ], "type": "object" }, { "required": [ "link" ], "type": "object" }, { "required": [ "valuesAlias" ], "type": "object" }, { "required": [ "valuesMapping" ], "type": "object" }, { "required": [ "columnDisplayName" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "thresholds" ], "type": "object" }, { "required": [ "alignment" ], "type": "object" }, { "required": [ "units" ], "type": "object" }, { "required": [ "regexExtract" ], "type": "object" }, { "required": [ "link" ], "type": "object" }, { "required": [ "valuesAlias" ], "type": "object" }, { "required": [ "valuesMapping" ], "type": "object" }, { "required": [ "columnDisplayName" ], "type": "object" } ] } } ], "properties": { "alignment": { "$ref": "#/components/schemas/TextAlignment" }, "columnDisplayName": { "description": "Column display name property, allows renaming the column header name", "examples": [ "Renamed header" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "link": { "allOf": [ { "$ref": "#/components/schemas/PropertyLinks" } ], "description": "Link property (see PropertyLinks for full reference)" }, "regexExtract": { "description": "Value of Regex Extract property, a regex string", "examples": [ "gr[ae]y" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "thresholds": { "$ref": "#/components/schemas/PropertyThresholds" }, "units": { "$ref": "#/components/schemas/PropertyUnits" }, "valuesAlias": { "description": "Value alias property, used to give alias names to selected fields", "examples": [ "Pod: {{$d.pod}}" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "valuesMapping": { "$ref": "#/components/schemas/PropertyValuesMapping" } }, "description": "Property definition." }, "PropertyLinks": { "type": "object", "properties": { "actions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LinkAction" }, "description": "Collection of link actions" } }, "description": "Property links." }, "PropertyThresholds": { "type": "object", "properties": { "max": { "description": "A maximum value used in relative thresholds to calculate the threshold levels", "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum value used in relative thresholds to calculate the threshold levels", "format": "double", "type": "number", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, can be relative or absolute", "examples": [ "1" ] }, "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of thresholds" } }, "description": "Property thresholds." }, "PropertyUnits": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires to set unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "max": { "description": "A maximum value used in percentage type unit (UNIT_PERCENT) for calculating displayed value", "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum value used in percentage type unit (UNIT_PERCENT) for calculating displayed value", "format": "double", "type": "number", "x-coralogix-presence": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] } }, "description": "Property units." }, "PropertyValuesMapping": { "type": "object", "properties": { "mappings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PropertyValuesMapping.ValueMapping" }, "description": "The mappings." } }, "description": "Property values mapping." }, "PropertyValuesMapping.ValueMapping": { "type": "object", "properties": { "inputValue": { "description": "The input value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "replaceValue": { "description": "The replace value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "type": { "$ref": "#/components/schemas/ValuesMappingType" } } }, "PushBasedContextualData": { "title": "Push based contextual data", "type": "object", "additionalProperties": false }, "Query.LogsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Query.LogsQuery.Type" } }, "description": "Logs query." }, "Query.LogsQuery.Type": { "type": "object", "oneOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" } ] } } ], "properties": { "fieldName": { "$ref": "#/components/schemas/Query.LogsQuery.Type.FieldName" }, "fieldValue": { "$ref": "#/components/schemas/Query.LogsQuery.Type.FieldValue" } }, "description": "Type." }, "Query.LogsQuery.Type.FieldName": { "type": "object", "properties": { "logRegex": { "description": "The log regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Fetches distinct log field names matching the given regex pattern." }, "Query.LogsQuery.Type.FieldValue": { "type": "object", "properties": { "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Fetches distinct values for a specific log observation field." }, "Query.MetricsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Query.MetricsQuery.Type" } }, "description": "Variable query source that fetches metric names, label names, or label values from the metrics store." }, "Query.MetricsQuery.Equals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/Query.MetricsQuery.Selection" } }, "description": "Equality filter operator: includes metrics whose label matches the selection." }, "Query.MetricsQuery.MetricsLabelFilter": { "type": "object", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/Query.MetricsQuery.StringOrVariable" } ], "description": "The label." }, "metric": { "$ref": "#/components/schemas/Query.MetricsQuery.StringOrVariable" }, "operator": { "$ref": "#/components/schemas/Query.MetricsQuery.Operator" } } }, "Query.MetricsQuery.NotEquals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/Query.MetricsQuery.Selection" } }, "description": "Non-equality filter operator: includes metrics whose label does not match the selection." }, "Query.MetricsQuery.Operator": { "type": "object", "oneOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" } ] } } ], "properties": { "equals": { "$ref": "#/components/schemas/Query.MetricsQuery.Equals" }, "notEquals": { "$ref": "#/components/schemas/Query.MetricsQuery.NotEquals" } }, "description": "Operator." }, "Query.MetricsQuery.Selection": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/Query.MetricsQuery.Selection.ListSelection" } }, "description": "Discriminated union of selection types for the filter operator." }, "Query.MetricsQuery.Selection.ListSelection": { "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Query.MetricsQuery.StringOrVariable" }, "description": "List of values." } }, "description": "A list-based selection of string-or-variable values for metrics label filtering." }, "Query.MetricsQuery.StringOrVariable": { "type": "object", "oneOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "variableName" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "variableName" ], "type": "object" } ] } } ], "properties": { "stringValue": { "description": "A literal string value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "variableName": { "description": "The name of a dashboard variable whose current value will be substituted.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "String or variable." }, "Query.MetricsQuery.Type": { "type": "object", "oneOf": [ { "required": [ "metricName" ], "type": "object" }, { "required": [ "labelName" ], "type": "object" }, { "required": [ "labelValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metricName" ], "type": "object" }, { "required": [ "labelName" ], "type": "object" }, { "required": [ "labelValue" ], "type": "object" } ] } } ], "properties": { "labelName": { "$ref": "#/components/schemas/Query.MetricsQuery.Type.LabelName" }, "labelValue": { "$ref": "#/components/schemas/Query.MetricsQuery.Type.LabelValue" }, "metricName": { "allOf": [ { "$ref": "#/components/schemas/Query.MetricsQuery.Type.MetricName" } ], "description": "The metric name." } }, "description": "Discriminated union specifying what kind of metric data to fetch: metric names, label names, or label values." }, "Query.MetricsQuery.Type.LabelName": { "type": "object", "properties": { "metricRegex": { "description": "The metric regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Label name." }, "Query.MetricsQuery.Type.LabelValue": { "type": "object", "properties": { "labelFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Query.MetricsQuery.MetricsLabelFilter" }, "description": "The label filters." }, "labelName": { "$ref": "#/components/schemas/Query.MetricsQuery.StringOrVariable" }, "metricName": { "allOf": [ { "$ref": "#/components/schemas/Query.MetricsQuery.StringOrVariable" } ], "description": "The metric name." } }, "description": "Label value." }, "Query.MetricsQuery.Type.MetricName": { "type": "object", "properties": { "metricRegex": { "description": "The metric regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Fetches distinct metric names matching the given regex pattern." }, "Query.SpansQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Query.SpansQuery.Type" } }, "description": "Spans query." }, "Query.SpansQuery.Type": { "type": "object", "oneOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" } ] } } ], "properties": { "fieldName": { "$ref": "#/components/schemas/Query.SpansQuery.Type.FieldName" }, "fieldValue": { "$ref": "#/components/schemas/Query.SpansQuery.Type.FieldValue" } }, "description": "Discriminated union specifying whether to query span field names or span field values." }, "Query.SpansQuery.Type.FieldName": { "type": "object", "properties": { "spanRegex": { "description": "The span regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Fetches distinct span field names matching the given regex pattern." }, "Query.SpansQuery.Type.FieldValue": { "type": "object", "properties": { "observationField": { "$ref": "#/components/schemas/ObservationField" }, "value": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "The value." } }, "description": "Fetches distinct values for a specific span observation field." }, "QueryDisplaySettings": { "title": "TimeSeriesLinesMultiQueryDisplaySettings", "required": [ "queryId" ], "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of category fields for grouping the query results" }, "colorScheme": { "description": "Applied color scheme for this query, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "queryId": { "description": "Reference to the query id from Dynamic.query_display_settings", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "seriesCountLimit": { "description": "Max count of the series per query", "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "seriesNameTemplate": { "description": "Custom template for the series name", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "temporalField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Temporal field for time series data" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "A list of numeric/value observation fields to display from the query results" }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Query display settings for time series lines multi-query visualization" }, "QuerySource.DataprimeQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataprimeQuery.Type" } }, "description": "Variable query source that executes a Dataprime query to populate variable values." }, "QuerySource.LogsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/QuerySource.LogsQuery.Type" } }, "description": "Logs query." }, "QuerySource.LogsQuery.Type": { "type": "object", "oneOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" } ] } } ], "properties": { "fieldName": { "$ref": "#/components/schemas/QuerySource.LogsQuery.Type.FieldName" }, "fieldValue": { "$ref": "#/components/schemas/QuerySource.LogsQuery.Type.FieldValue" } }, "description": "Type." }, "QuerySource.LogsQuery.Type.FieldName": { "type": "object", "properties": { "logRegex": { "description": "The log regex. Not implemented — see the parent schema.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "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." }, "QuerySource.LogsQuery.Type.FieldValue": { "required": [ "observationField" ], "type": "object", "properties": { "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Fetches distinct values for a specific log observation field. observationField is required and must be set." }, "QuerySource.MetricsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Type" } }, "description": "Variable query source that fetches metric names, label names, or label values from the metrics store." }, "QuerySource.MetricsQuery.Equals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Selection" } }, "description": "Equals." }, "QuerySource.MetricsQuery.MetricsLabelFilter": { "type": "object", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/QuerySource.MetricsQuery.StringOrVariable" } ], "description": "The label." }, "metric": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.StringOrVariable" }, "operator": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Operator" } } }, "QuerySource.MetricsQuery.NotEquals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Selection" } }, "description": "Not equals." }, "QuerySource.MetricsQuery.Operator": { "type": "object", "oneOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "equals" ], "type": "object" }, { "required": [ "notEquals" ], "type": "object" } ] } } ], "properties": { "equals": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Equals" }, "notEquals": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.NotEquals" } }, "description": "Discriminated union of filter operators: equals or not equals." }, "QuerySource.MetricsQuery.Selection": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Selection.ListSelection" } }, "description": "Selection." }, "QuerySource.MetricsQuery.Selection.ListSelection": { "type": "object", "properties": { "values": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.StringOrVariable" }, "description": "List of values." } }, "description": "A list-based selection of string-or-variable values for metrics label filtering." }, "QuerySource.MetricsQuery.StringOrVariable": { "type": "object", "oneOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "variableName" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "stringValue" ], "type": "object" }, { "required": [ "variableName" ], "type": "object" } ] } } ], "properties": { "stringValue": { "description": "A literal string value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "variableName": { "description": "The name of a dashboard variable whose current value will be substituted.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Query.metrics query.string or variable." }, "QuerySource.MetricsQuery.Type": { "type": "object", "oneOf": [ { "required": [ "metricName" ], "type": "object" }, { "required": [ "labelName" ], "type": "object" }, { "required": [ "labelValue" ], "type": "object" }, { "required": [ "promqlQuery" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metricName" ], "type": "object" }, { "required": [ "labelName" ], "type": "object" }, { "required": [ "labelValue" ], "type": "object" }, { "required": [ "promqlQuery" ], "type": "object" } ] } } ], "properties": { "labelName": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Type.LabelName" }, "labelValue": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Type.LabelValue" }, "metricName": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.Type.MetricName" }, "promqlQuery": { "$ref": "#/components/schemas/PromqlQuery" } }, "description": "Discriminated union specifying what kind of metric data to fetch: metric names, label names, or label values." }, "QuerySource.MetricsQuery.Type.LabelName": { "type": "object", "properties": { "metricRegex": { "description": "The metric regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Label name." }, "QuerySource.MetricsQuery.Type.LabelValue": { "required": [ "labelName" ], "type": "object", "properties": { "labelFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.MetricsLabelFilter" }, "description": "The label filters." }, "labelName": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.StringOrVariable" }, "metricName": { "$ref": "#/components/schemas/QuerySource.MetricsQuery.StringOrVariable" } }, "description": "Fetches distinct values of a metric label. labelName is required and must be non-empty; metricName selects the metric to read the label from." }, "QuerySource.MetricsQuery.Type.MetricName": { "type": "object", "properties": { "metricRegex": { "description": "The metric regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Query.metrics query.type.metric name." }, "QuerySource.SpansQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/QuerySource.SpansQuery.Type" } }, "description": "Spans query." }, "QuerySource.SpansQuery.Type": { "type": "object", "oneOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "fieldName" ], "type": "object" }, { "required": [ "fieldValue" ], "type": "object" } ] } } ], "properties": { "fieldName": { "$ref": "#/components/schemas/QuerySource.SpansQuery.Type.FieldName" }, "fieldValue": { "$ref": "#/components/schemas/QuerySource.SpansQuery.Type.FieldValue" } }, "description": "Discriminated union specifying whether to query span field names or span field values." }, "QuerySource.SpansQuery.Type.FieldName": { "type": "object", "properties": { "spanRegex": { "description": "The span regex. Not implemented — see the parent schema.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "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." }, "QuerySource.SpansQuery.Type.FieldValue": { "type": "object", "properties": { "observationField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "The span observation field to fetch values for. Preferred over value. Setting both observationField and value is rejected." }, "value": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "Deprecated. Legacy span field addressing. Use observationField instead. Setting both value and observationField is rejected.", "deprecated": true } }, "description": "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." }, "QueryText": { "type": "object", "properties": { "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/v1.common.DataModeType" } ], "description": "Data mode. Omitted or DATA_MODE_TYPE_HIGH_UNSPECIFIED queries high-priority ('Frequent Search') data; DATA_MODE_TYPE_ARCHIVE queries archive ('Monitoring') data." }, "query": { "$ref": "#/components/schemas/common.DataprimeQuery" } }, "description": "Query text." }, "QuickTimeSelection": { "required": [ "seconds" ], "type": "object", "properties": { "caption": { "deprecated": true, "description": "Display label for the quick time range.", "examples": [ "Last Hour" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "seconds": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Length of the quick time range, in seconds. The service stores the nearest of 60, 120, 300, 900, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 432000, and 604800.", "format": "int64", "examples": [ 3600 ] } }, "description": "Quick time selection." }, "QuotaAllocationEntityTypeRule": { "title": "Quota allocation entity type rule", "required": [ "entityType", "allocation", "enabled", "canOverflow" ], "type": "object", "properties": { "allocation": { "minimum": 0, "type": "number", "description": "The allocation. A percentage allocation (the default type) is between 0 and 100, and the percentages of the enabled rules must sum to at most 100. A locked units allocation is a non-negative number of units.", "format": "float" }, "allocationType": { "allOf": [ { "$ref": "#/components/schemas/QuotaAllocationType" } ], "description": "Determines whether allocation is interpreted as a percentage or locked units. Unspecified defaults to percentage for backwards compatibility." }, "canOverflow": { "type": "boolean", "description": "The can overflow." }, "cxManaged": { "type": "boolean", "description": "Indicates whether the quota allocation rule is managed by Coralogix. This field is returned by the service and must not be sent in Create or Replace requests.", "readOnly": true }, "enabled": { "type": "boolean", "description": "Whether this resource is enabled." }, "entityType": { "minLength": 1, "type": "string", "description": "The entity type." } }, "description": "Defines quota allocation rule for a specific entity type" }, "QuotaAllocationEntityTypeRuleSet": { "title": "Quota allocation entity type rule set", "type": "object", "properties": { "id": { "minLength": 0, "type": "string", "description": "Unique identifier." }, "rules": { "description": "List of rules. The server does not keep the order of the rules. Each entity type can have one rule: the service rejects a request with two rules for the same entity type, so a list never has two equal rules. In a `POST` or `PUT` request, an empty or omitted list clears the rules of the customer. In a response, an omitted list is an empty rule set.", "items": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRule" }, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Contains a collection of quota allocation rules for entity types" }, "QuotaAllocationType": { "title": "Quota allocation type", "enum": [ "QUOTA_ALLOCATION_TYPE_UNSPECIFIED", "QUOTA_ALLOCATION_TYPE_PERCENTAGE", "QUOTA_ALLOCATION_TYPE_LOCKED_UNITS" ], "type": "string", "description": "Specifies whether the allocation value is interpreted as a percentage or as locked units." }, "QuotaBased": { "type": "object", "properties": { "usageTiers": { "maxItems": 3, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageTier" }, "description": "Ordered list of usage tiers that map daily quota consumption percentages to priority levels. Percentages must be strictly increasing and priorities strictly decreasing, using only LOW, MEDIUM, or HIGH.", "examples": [ [ { "daily_quota_percentage": 80, "priority": "PRIORITY_TYPE_HIGH" } ] ] } }, "description": "Quota based." }, "QuotaBasedStatus": { "type": "object", "properties": { "currentPriority": { "$ref": "#/components/schemas/quota.v1.Priority" }, "currentUsage": { "description": "The current usage.", "format": "double", "type": "number", "x-coralogix-presence": true }, "dailyLimit": { "description": "The daily limit.", "format": "double", "type": "number", "x-coralogix-presence": true } }, "description": "Quota based status." }, "RangeMapping": { "title": "RangeMapping", "type": "object", "properties": { "minMax": { "allOf": [ { "$ref": "#/components/schemas/MinMax" } ], "description": "Min/max range configuration, auto-derived from data or custom values" }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of color thresholds defining color ranges" } }, "description": "Range-based color mapping using min/max bounds and color thresholds" }, "RawConfigurationFamily": { "required": [ "remoteConfigurations" ], "type": "object", "properties": { "collectorVersion": { "description": "Collector semantic version targeted by this family. This is separate from the family version and the Supervisor image tag.", "examples": [ "0.160.0" ], "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", "x-coralogix-presence": true }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Metadata stored with this configuration family. Example: `{\"team\":\"platform\"}`." }, "remoteConfigurations": { "maxItems": 128, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RemoteConfiguration" }, "description": "Remote configurations of this configuration family." } }, "description": "Inputs of a configuration family defined directly by its remote configurations." }, "RawConfigurationFamilyCreate": { "required": [ "remoteConfigurations" ], "type": "object", "properties": { "collectorVersion": { "description": "Collector semantic version targeted by this family, without a leading v prefix. Use the Collector version, not the Supervisor image tag. This field has no impact on agent selector matching.", "examples": [ "0.160.0" ], "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", "x-coralogix-presence": true }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Additional key-value metadata stored with the family. It does not select agents. Example: `{\"team\":\"platform\"}`." }, "remoteConfigurations": { "maxItems": 128, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RemoteConfigurationCreate" }, "description": "Collector configurations and selectors to create together. Include at least one entry." } }, "description": "Configuration family content defined directly by its remote configurations." }, "RawConfigurationFamilyUpdate": { "type": "object", "properties": { "collectorVersion": { "description": "Collector semantic version targeted by this family, without a leading v prefix. Use the Collector version, not the Supervisor image tag. This field has no impact on agent selector matching.", "examples": [ "0.160.0" ], "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", "x-coralogix-presence": true }, "metadata": { "maxProperties": 64, "type": "object", "additionalProperties": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string" }, "description": "Additional key-value metadata stored with the family. It does not select agents. Example: `{\"team\":\"platform\"}`." }, "remoteConfigurations": { "maxItems": 128, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RemoteConfigurationReplace" }, "description": "Remote configurations for the new family version." } }, "description": "Content of the latest configuration family. With family.raw in update_mask, remoteConfigurations is required and the content replaces the remote configurations, collector version, and metadata; an omitted collectorVersion or metadata is cleared. With a field path, only that field is needed and changes." }, "Recipients": { "title": "Recipients", "type": "object", "properties": { "emails": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The list of email recipients for alert notifications" }, "description": "The list of email recipients for alert notifications", "examples": [ [ "mail@gmail.com" ] ] } }, "description": "List of email recipients for alert notifications" }, "Recurrence": { "type": "object", "properties": { "weekly": { "$ref": "#/components/schemas/WeeklyRecurrence" } }, "description": "Recurrence." }, "Recurring": { "type": "object", "oneOf": [ { "required": [ "alwaysActive" ], "type": "object" }, { "required": [ "schedule" ], "type": "object" } ], "properties": { "alwaysActive": { "$ref": "#/components/schemas/Always" }, "schedule": { "$ref": "#/components/schemas/Recurring.Dynamic" } }, "description": "Recurring schedule that activates the alert scheduler rule on a repeating cadence." }, "Recurring.Dynamic": { "required": [ "timeframe" ], "type": "object", "oneOf": [ { "required": [ "daily" ], "type": "object" }, { "required": [ "weekly" ], "type": "object" }, { "required": [ "monthly" ], "type": "object" } ], "properties": { "daily": { "$ref": "#/components/schemas/Daily" }, "monthly": { "$ref": "#/components/schemas/Monthly" }, "repeatEvery": { "type": "integer", "description": "Interval multiplier controlling how often the rule recurs (e.g., every N days, weeks, or months).", "format": "int32" }, "terminationDate": { "description": "ISO 8601 date after which the recurring rule stops being applied.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "timeframe": { "$ref": "#/components/schemas/Timeframe" }, "weekly": { "$ref": "#/components/schemas/Weekly" } }, "description": "Dynamic." }, "RegexMapping": { "title": "RegexMapping", "type": "object", "properties": { "sections": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/MappingSection" }, "description": "List of regex pattern-to-display mapping sections" } }, "description": "Regex pattern-based color and label mapping" }, "RegexValue": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/StringValueLabel" } ], "description": "The value." } }, "description": "Regex value." }, "RegisteredInstance": { "title": "Registered instance", "type": "object", "oneOf": [ { "required": [ "empty" ], "type": "object" }, { "required": [ "cloudformation" ], "type": "object" }, { "required": [ "arm" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "empty" ], "type": "object" }, { "required": [ "cloudformation" ], "type": "object" }, { "required": [ "arm" ], "type": "object" } ] } } ], "properties": { "arm": { "$ref": "#/components/schemas/ARMStack" }, "cloudformation": { "$ref": "#/components/schemas/CloudFormationStack" }, "definitionVersion": { "description": "The definition version.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "empty": { "$ref": "#/components/schemas/NoDeployment" }, "id": { "description": "Unique identifier.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrationStatus": { "$ref": "#/components/schemas/IntegrationStatus" }, "isTesting": { "description": "Whether this is a testing instance used for validation purposes only.", "type": "boolean", "x-coralogix-presence": true }, "lastUpdated": { "description": "Timestamp of the last update to this integration instance.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "parameters": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "description": "The parameters." }, "revisionLifecycle": { "$ref": "#/components/schemas/RevisionLifecycle" } } }, "RemoteConfiguration": { "required": [ "id", "hash", "rawConfiguration" ], "type": "object", "properties": { "agentSelector": { "allOf": [ { "$ref": "#/components/schemas/AgentSelectorResponse" } ], "description": "Flat agent attributes that match agents for this configuration." }, "createdAt": { "description": "Time when this remote configuration was created.", "examples": [ "2026-10-08T09:41:01.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "hash": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "SHA-256 hash of the normalized raw configuration content.", "examples": [ "3f2b8c1d9e7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a2b1c" ] }, "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.", "examples": [ "01975ed4-9c1c-7d3b-af60-626614174002" ] }, "name": { "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Remote configuration name.", "examples": [ "host-metrics" ] }, "rawConfiguration": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Collector YAML sent to matching agents.", "examples": [ "receivers:\n otlp:\n protocols:\n grpc:\n http:\nexporters:\n otlp:\n endpoint: otelcol:4317\nservice:\n pipelines:\n logs:\n receivers: [otlp]\n exporters: [otlp]" ] }, "updatedAt": { "description": "Time when this remote configuration was last updated.", "examples": [ "2026-10-08T09:41:01.000Z" ], "format": "date-time", "maxLength": 64, "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Remote configuration returned by Fleet Manager." }, "RemoteConfigurationCreate": { "required": [ "rawConfiguration" ], "type": "object", "properties": { "agentSelector": { "allOf": [ { "$ref": "#/components/schemas/AgentSelectorRequest" } ], "description": "Attributes advertised by the target agents. All attributes must match; set custom attributes under agent_description.non_identifying_attributes of the opamp extension in the Collector configuration, or under agent.description.non_identifying_attributes in the Supervisor configuration." }, "name": { "description": "Name identifying this configuration within the family.", "examples": [ "host-metrics" ], "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "rawConfiguration": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Collector configuration YAML encoded as a JSON string. Use newline escapes (\\n) between YAML lines. Environment references such as `${env:CORALOGIX_PRIVATE_KEY}` are resolved on the Collector host. Do not define the Supervisor-managed opamp extension.", "examples": [ "receivers:\n otlp:\n protocols:\n grpc:\n http:\nexporters:\n otlp:\n endpoint: otelcol:4317\nservice:\n pipelines:\n logs:\n receivers: [otlp]\n exporters: [otlp]" ] } }, "description": "Collector YAML and the agent attributes that select where it is delivered." }, "RemoteConfigurationReplace": { "required": [ "rawConfiguration" ], "type": "object", "properties": { "agentSelector": { "allOf": [ { "$ref": "#/components/schemas/AgentSelectorRequest" } ], "description": "Attributes advertised by the target agents. All attributes must match; set custom attributes under agent_description.non_identifying_attributes of the opamp extension in the Collector configuration, or under agent.description.non_identifying_attributes in the Supervisor configuration." }, "name": { "description": "Name identifying this configuration within the family.", "examples": [ "host-metrics" ], "maxLength": 256, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "rawConfiguration": { "maxLength": 1048576, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Collector configuration YAML encoded as a JSON string. Use newline escapes (\\n) between YAML lines. Environment references such as `${env:CORALOGIX_PRIVATE_KEY}` are resolved on the Collector host. Do not define the Supervisor-managed opamp extension.", "examples": [ "receivers:\n otlp:\n protocols:\n grpc:\n http:\nexporters:\n otlp:\n endpoint: otelcol:4317\nservice:\n pipelines:\n logs:\n receivers: [otlp]\n exporters: [otlp]" ] } }, "description": "A complete remote configuration in a replacement collection. Supply the YAML; entries are not patched by name. The agent selector is optional: an omitted or empty selector matches all agents." }, "RemoveEnrichmentsResponse": { "title": "Encrichments Delettion Response", "type": "object", "properties": { "remainingEnrichments": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "description": "The remaining enrichments." } }, "description": "Response data structure for enrichments deletion", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "RemoveFieldsParameters": { "required": [ "fields" ], "type": "object", "properties": { "fields": { "minItems": 1, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The fields to remove from the log. At least one." }, "description": "The fields to remove from the log. At least one." } }, "description": "Remove fields parameters." }, "ReorderPoliciesResponse": { "title": "Reorder Policies Response", "required": [ "orders" ], "type": "object", "properties": { "orders": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PolicyOrder" }, "description": "The orders." } }, "description": "This data structure is obtained when reordering policies.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "RepetitiveVar": { "type": "object", "properties": { "name": { "description": "Variable name that can be applied on section making it repetitive section", "examples": [ "pod_name" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Repetitive var." }, "ReplaceActionRequest": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/v2.Action" } } }, "ReplaceActionResponse": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/v2.Action" } } }, "ReplaceAlertDefResponse": { "title": "Replace alert definition response", "type": "object", "properties": { "alertDef": { "allOf": [ { "$ref": "#/components/schemas/AlertDef" } ], "description": "The updated alert definition" } }, "description": "A response that contains the updated alert definition" }, "ReplaceCompanyIpAccessSettingsResponse": { "title": "Replace company IP access settings response", "type": "object", "properties": { "settings": { "allOf": [ { "$ref": "#/components/schemas/CompanyIpAccessSettings" } ], "description": "The replaced company IP access settings." } } }, "ReplaceConnectorResponse": { "title": "Replace Connector Response", "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/Connector" } }, "description": "Response containing the updated connector", "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", "properties": { "preset": { "$ref": "#/components/schemas/Preset" } }, "description": "Response containing the updated custom preset", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ReplaceDashboardFolderResponse": { "title": "Replace dashboard folder response data structure", "type": "object", "additionalProperties": false, "description": "Response returned after successfully replacing a dashboard folder.", "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", "additionalProperties": false, "description": "This is a response received when the dashboard is successfully updated", "externalDocs": { "description": "Find out more 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", "additionalProperties": false, "description": "This is a response received when default dashboard has been replaced", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "ReplaceE2MRequest": { "title": "Replace E2M Request", "required": [ "e2m" ], "type": "object", "properties": { "e2m": { "allOf": [ { "$ref": "#/components/schemas/E2M" } ], "description": "The e2m." } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "ReplaceE2MResponse": { "title": "Replace E2M Response", "required": [ "e2m" ], "type": "object", "properties": { "e2m": { "allOf": [ { "$ref": "#/components/schemas/E2M" } ], "description": "The e2m." } }, "description": "This data structure is obtained when replacing an existing event to metric definition", "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "ReplaceGlobalRouterResponse": { "title": "Replace Global Router Response", "type": "object", "properties": { "router": { "$ref": "#/components/schemas/GlobalRouter" } }, "description": "Response which contains an updated global router", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ReplaceParameters": { "required": [ "rule", "destinationField", "replaceNewVal" ], "type": "object", "properties": { "destinationField": { "description": "The field that receives the result. An empty string writes to the source field.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "replaceNewVal": { "description": "The text that replaces each match. An empty string removes the match.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "rule": { "description": "The regular expression that selects the text to replace. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Replace parameters. Replaces the text that the regular expression matches." }, "ReplacePolicySettingsResponse": { "title": "Replace Policy Settings Response", "type": "object", "properties": { "logsPolicySettings": { "$ref": "#/components/schemas/LogsPolicySettings" }, "spansPolicySettings": { "$ref": "#/components/schemas/SpansPolicySettings" } }, "description": "This data structure is returned when replacing policy settings. It contains the complete resource including server-generated fields." }, "ReplaceQuotaAllocationRuleSetResponse": { "title": "Replace quota allocation rule set response", "type": "object", "properties": { "ruleSet": { "$ref": "#/components/schemas/QuotaAllocationEntityTypeRuleSet" } }, "description": "Response confirming quota allocation rule set has been successfully replaced" }, "ReplaceSloAlertsValidationsResponse": { "title": "ReplaceSloAlertsValidationsResponse", "required": [ "alertsValidationResult" ], "type": "object", "properties": { "alertsValidationResult": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SloAlertValidityResult" }, "description": "The alerts validation result." } }, "description": "Response with validated alerts before replacing an existing SLO." }, "ReplaceSloRequest": { "title": "ReplaceSloRequest", "required": [ "slo" ], "type": "object", "properties": { "silenceDataValidations": { "deprecated": true, "description": "Whether to silence data validations.", "type": "boolean", "x-coralogix-presence": true }, "slo": { "$ref": "#/components/schemas/Slo" } }, "description": "Request to replace an existing SLO." }, "ReplaceSloResponse": { "title": "ReplaceSloResponse", "required": [ "slo" ], "type": "object", "properties": { "effectedSloAlertIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The effected slo alert ids." }, "description": "The effected slo alert ids." }, "slo": { "$ref": "#/components/schemas/Slo" } }, "description": "Response after replacing an existing SLO." }, "RequestBasedMetricSli": { "title": "RequestBasedMetricSli", "required": [ "goodEvents", "totalEvents" ], "type": "object", "properties": { "goodEvents": { "$ref": "#/components/schemas/Metric" }, "totalEvents": { "$ref": "#/components/schemas/Metric" } }, "description": "Definition of a request-based SLI based on metrics" }, "ResolutionDetails": { "title": "Resolution details", "type": "object", "properties": { "reason": { "description": "Resolution reason", "examples": [ "Case was not applicable." ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "resolveTime": { "description": "Timestamp when the case was resolved", "examples": [ "2025-09-22T11:15:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/CaseResolver" } ], "description": "Entity that resolved the case" } }, "description": "Information about how and when a case was resolved." }, "ResolutionReasonChangedCaseEvent": { "title": "Resolution reason changed event", "type": "object", "properties": { "from": { "description": "Previous resolution reason. Leading and trailing whitespace is trimmed before the length limits are applied.", "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "to": { "maxLength": 500, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "New resolution reason. Leading and trailing whitespace is trimmed before the length limits are applied." } }, "description": "Resolution reason changed case event." }, "ResolveCaseResponse": { "title": "Resolve case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after resolution." } }, "description": "Response containing the case after it has been resolved." }, "ResolveIncidentByEventIdResponse": { "title": "Acknowledge incident by event id response", "required": [ "incident" ], "type": "object", "properties": { "incident": { "allOf": [ { "$ref": "#/components/schemas/Incident" } ], "description": "Incident after resolution" } }, "description": "Response containing the updated incident after resolution" }, "ResolveIncidentsResponse": { "title": "Resolve incidents response", "required": [ "incidents" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "List of incidents after resolution" } }, "description": "Response containing the updated incidents after resolution" }, "Resolved": { "title": "Resolved Prometheus alert status", "required": [ "triggeredAt", "resolvedAt" ], "type": "object", "properties": { "resolvedAt": { "description": "Timestamp when the alert was resolved.", "examples": [ "2025-09-22T11:05:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "triggeredAt": { "description": "Timestamp when the alert was originally triggered.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Status payload for a resolved Prometheus alert." }, "ResponseStatus": { "title": "ResponseStatus", "required": [ "statusCode" ], "type": "object", "properties": { "details": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of details." }, "message": { "description": "Human-readable message.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "statusCode": { "$ref": "#/components/schemas/Code" } }, "description": "Status of the response, including error code and message." }, "RestrictedTopicsConfig": { "required": [ "topics" ], "type": "object", "properties": { "topics": { "description": "Topics that should not appear.", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "Topics that should not appear." }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the RestrictedTopics evaluation." }, "RetentionPolicyRequest": { "title": "Retenion Policy Request", "type": "object", "properties": { "fiveMinutesResolution": { "minimum": 0, "type": "integer", "description": "The five minutes resolution.", "format": "int64", "examples": [ 2 ] }, "oneHourResolution": { "minimum": 0, "type": "integer", "description": "The one hour resolution.", "format": "int64", "examples": [ 3 ] }, "rawResolution": { "minimum": 0, "type": "integer", "description": "The raw resolution.", "format": "int64", "examples": [ 1 ] } }, "externalDocs": { "description": "Find out more about metrics cost optimization", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/" } }, "RetentionUpdateElement": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "description": "The id of an existing retention of the team. Must be a UUID: another value answers 400, and an id that does not exist answers 404.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "name": { "description": "The new display name. Names are unique within the request. The name of the first retention, `Default`, cannot change: another name answers 403.", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "x-coralogix-presence": true } } }, "RevisionLifecycle": { "enum": [ "REVISION_LIFECYCLE_UNSPECIFIED", "REVISION_LIFECYCLE_ALPHA", "REVISION_LIFECYCLE_PRIVATE_BETA", "REVISION_LIFECYCLE_PUBLIC_BETA", "REVISION_LIFECYCLE_GA", "REVISION_LIFECYCLE_DEPRECATED" ], "type": "string", "description": "Revision lifecycle." }, "RevisionRef": { "title": "Revision reference", "type": "object", "properties": { "descriptionMd": { "maxLength": 1048576, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The description md." }, "version": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Version number." } } }, "Role": { "title": "Role", "type": "object", "properties": { "description": { "minLength": 0, "type": "string", "description": "Role description" }, "name": { "minLength": 0, "type": "string", "description": "Unique role name" }, "roleId": { "minimum": 0, "type": "integer", "description": "Unique role identifier", "format": "int64" } }, "description": "A role that can be assigned to a group. Each role has a collection of permissions associated with it." }, "RoleUpdate": { "title": "RoleUpdate", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/RoleUpdateAction" } }, "description": "Update the role assigned to the group. Either set a new role or clear the existing one.", "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/" } }, "RoleUpdateAction": { "required": [ "actionType" ], "type": "object", "oneOf": [ { "required": [ "setRoleId" ], "type": "object" }, { "required": [ "clear" ], "type": "object" }, { "required": [ "setRoleByName" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "setRoleId" ], "type": "object" }, { "required": [ "clear" ], "type": "object" }, { "required": [ "setRoleByName" ], "type": "object" } ] } } ], "properties": { "actionType": { "minLength": 0, "type": "string", "description": "Discriminator indicating the role update action type (set_role_id or clear)." }, "clear": { "allOf": [ { "$ref": "#/components/schemas/ClearRole" } ], "description": "The clear." }, "setRoleByName": { "allOf": [ { "$ref": "#/components/schemas/SetRoleByName" } ], "description": "Set the role by name rather than by id. Select this arm by sending `actionType: \"set_role_by_name\"`." }, "setRoleId": { "$ref": "#/components/schemas/SetRoleId" } }, "description": "Clear role.", "discriminator": { "propertyName": "actionType" } }, "RoutedDelivery": { "title": "Routed delivery", "required": [ "router", "attempts" ], "type": "object", "properties": { "attempts": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DeliveryAttempt" }, "description": "Individual delivery attempts to connectors" }, "router": { "allOf": [ { "$ref": "#/components/schemas/RouterInfo" } ], "description": "The router that handled the notification" } }, "description": "Delivery attempts routed through a single router to one or more connectors." }, "RouterInfo": { "title": "Router info", "required": [ "routerId", "routerName" ], "type": "object", "properties": { "routerId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "Unique identifier of the router", "examples": [ "d4e5f678-90ab-cdef-1234-567890abcdef" ] }, "routerName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name of the router", "examples": [ "Production alerts router" ] } }, "description": "Information about a notification router." }, "RoutingLabels": { "title": "Routing Labels", "type": "object", "properties": { "environment": { "description": "The environment. The limit is 255 bytes.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "service": { "description": "Service name. The limit is 255 bytes.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "team": { "description": "Team. The limit is 255 bytes.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Allows to configure routing labels which are used for routers resolution. Every router needs at least one label, except the default router, whose `id` is `router_default`. The default router must have no labels.", "externalDocs": { "description": "Find out more how label based routers work", "url": "https://coralogix.com/docs/user-guides/notification-center/routing/introduction/#how-label-based-routers-work" } }, "RoutingRule": { "title": "Routing Rule", "required": [ "condition", "name" ], "type": "object", "properties": { "condition": { "maxLength": 20000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Condition.", "examples": [ "alertDef.priority == 'P3'" ] }, "customDetails": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The custom details." }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/notification_center.EntityType" } ], "default": "ALERTS", "examples": [ "ALERTS" ], "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 200, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targets": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RoutingTarget" }, "description": "List of targets. The server does not keep the order of the targets." } }, "description": "Defines routing rule for notifications", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "RoutingTarget": { "title": "Routing Target", "required": [ "connectorId" ], "type": "object", "properties": { "connectorId": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "The connector id." }, "customDetails": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "The custom details." }, "id": { "description": "Unique identifier. Set by the server, which assigns a new value on every create and replace; a value sent by the client is ignored.", "examples": [ "d4b56246-64bb-4714-a8bd-97c999f1d801" ], "maxLength": 36, "minLength": 36, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "presetId": { "description": "The preset id.", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Defines routing target for notifications", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "Row": { "type": "object", "properties": { "appearance": { "allOf": [ { "$ref": "#/components/schemas/Row.Appearance" } ], "description": "Row appearance configuration" }, "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Row unique identifier" }, "widgets": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Widget" }, "description": "The list of widgets in the row" } } }, "Row.Appearance": { "type": "object", "properties": { "height": { "description": "Height of a row, defined as a multiplier number of the base height, where 1 = 1 * base height, 2 = 2 * base height etc", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true } }, "description": "Appearance." }, "RowStyle": { "enum": [ "ROW_STYLE_UNSPECIFIED", "ROW_STYLE_ONE_LINE", "ROW_STYLE_TWO_LINE", "ROW_STYLE_CONDENSED", "ROW_STYLE_JSON", "ROW_STYLE_LIST" ], "type": "string", "description": "Row style." }, "RuleGroup": { "required": [ "id", "name", "description", "enabled", "hidden", "order", "ruleSubgroups" ], "type": "object", "properties": { "creator": { "description": "Free-form name of the creator, as the client sent it. A request without it stores an empty string, but a response can omit it.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the group is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "hidden": { "default": false, "description": "A free-form flag for clients, for example to hide the group in a UI. The service stores and returns it and does not act on it. Defaults to false.", "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "order": { "default": 1, "description": "Position of the group among the rule groups of the company. Defaults to 1. A request with 0 places the group last. Groups can share an order: the service does not shift the other groups.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "ruleMatchers": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RuleMatcher" }, "description": "The rule matchers." }, "ruleSubgroups": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RuleSubgroup" }, "description": "The rule subgroups, sorted by order." } }, "description": "Rule group. Every scalar field except `creator` is always returned." }, "RuleGroupSetListing": { "title": "Rule Group Set Listing", "required": [ "sets" ], "type": "object", "properties": { "sets": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/OutRuleGroupSet" }, "description": "The sets." } }, "description": "A listing of rule group sets.", "externalDocs": { "description": "Find out more about recording rules", "url": "https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/" } }, "RuleMatcher": { "type": "object", "oneOf": [ { "required": [ "applicationName" ], "type": "object" }, { "required": [ "subsystemName" ], "type": "object" }, { "required": [ "severity" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "applicationName" ], "type": "object" }, { "required": [ "subsystemName" ], "type": "object" }, { "required": [ "severity" ], "type": "object" } ] } } ], "properties": { "applicationName": { "$ref": "#/components/schemas/ApplicationNameConstraint" }, "severity": { "$ref": "#/components/schemas/SeverityConstraint" }, "subsystemName": { "$ref": "#/components/schemas/SubsystemNameConstraint" } } }, "RuleParameters": { "type": "object", "oneOf": [ { "required": [ "extractParameters" ], "type": "object" }, { "required": [ "jsonExtractParameters" ], "type": "object" }, { "required": [ "replaceParameters" ], "type": "object" }, { "required": [ "parseParameters" ], "type": "object" }, { "required": [ "allowParameters" ], "type": "object" }, { "required": [ "blockParameters" ], "type": "object" }, { "required": [ "extractTimestampParameters" ], "type": "object" }, { "required": [ "removeFieldsParameters" ], "type": "object" }, { "required": [ "jsonStringifyParameters" ], "type": "object" }, { "required": [ "jsonParseParameters" ], "type": "object" } ], "properties": { "allowParameters": { "$ref": "#/components/schemas/AllowParameters" }, "blockParameters": { "$ref": "#/components/schemas/BlockParameters" }, "extractParameters": { "$ref": "#/components/schemas/ExtractParameters" }, "extractTimestampParameters": { "$ref": "#/components/schemas/ExtractTimestampParameters" }, "jsonExtractParameters": { "$ref": "#/components/schemas/JsonExtractParameters" }, "jsonParseParameters": { "$ref": "#/components/schemas/JsonParseParameters" }, "jsonStringifyParameters": { "$ref": "#/components/schemas/JsonStringifyParameters" }, "parseParameters": { "$ref": "#/components/schemas/ParseParameters" }, "removeFieldsParameters": { "$ref": "#/components/schemas/RemoveFieldsParameters" }, "replaceParameters": { "$ref": "#/components/schemas/ReplaceParameters" } }, "description": "Rule parameters. Exactly one parameters object must be set; an empty object is rejected." }, "RuleScope": { "type": "object", "oneOf": [ { "required": [ "field" ], "type": "object" }, { "required": [ "regex" ], "type": "object" }, { "required": [ "fieldType" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "field" ], "type": "object" }, { "required": [ "regex" ], "type": "object" }, { "required": [ "fieldType" ], "type": "object" } ] } } ], "properties": { "field": { "$ref": "#/components/schemas/ObservationField" }, "fieldType": { "$ref": "#/components/schemas/FieldDataType" }, "regex": { "description": "Regular expression pattern used to scope the rule.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Rule scope." }, "RuleSubgroup": { "required": [ "id", "enabled", "order", "rules" ], "type": "object", "properties": { "enabled": { "default": true, "description": "Whether the subgroup is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier. Set by the server, and regenerated for every subgroup on each update of the group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "order": { "description": "Position of the subgroup in the group, starting at 1. Get returns the subgroups sorted by order.", "format": "int64", "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "rules": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/rules.v1.Rule" }, "description": "The rules of the subgroup, sorted by order." } }, "description": "A rule subgroup. Get returns every scalar field." }, "RuleTypeId": { "enum": [ "RULE_TYPE_ID_UNSPECIFIED", "RULE_TYPE_ID_IS", "RULE_TYPE_ID_IS_NOT", "RULE_TYPE_ID_START_WITH", "RULE_TYPE_ID_INCLUDES" ], "type": "string", "description": "Rule type id." }, "Rum": { "title": "RUM", "type": "object", "properties": { "browserSdkCommands": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CommandInformation" }, "description": "The browser sdk commands." }, "sourceMapCommands": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CommandInformation" }, "description": "The source map commands." } } }, "RumLink": { "title": "RUM link", "type": "object", "properties": { "rum": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "RUM errors URL pre-filtered to the alert applications and case time window." } }, "description": "Deep link to the RUM errors view scoped to an alert indicator on a case." }, "RumVersionData": { "title": "RUM version data", "type": "object", "properties": { "syncedAt": { "description": "The synced at.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "versions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/RumVersionData.Version" }, "description": "The versions." } }, "description": "Rum version data." }, "RumVersionData.Version": { "title": "Version", "type": "object", "properties": { "logMetadata": { "$ref": "#/components/schemas/LogMetadata" }, "sourceMapMetadata": { "$ref": "#/components/schemas/SourceMapMetadata" }, "version": { "description": "Version number.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "S3Config": { "title": "S3 Configuration", "type": "object", "properties": { "bucket": { "minLength": 0, "type": "string", "description": "Bucket name." }, "region": { "minLength": 0, "type": "string", "description": "Region." } }, "externalDocs": { "description": "Find out more about metrics cost optimization", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/metrics-optimization/" } }, "S3TargetServiceGetTargetResponse": { "title": "Get Target Response", "required": [ "target" ], "type": "object", "properties": { "target": { "$ref": "#/components/schemas/v2.Target" } }, "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": [ "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/" } }, "S3TargetSpec": { "title": "S3 Target Spec", "required": [ "bucket" ], "type": "object", "properties": { "bucket": { "minLength": 3, "type": "string", "description": "Bucket name.", "examples": [ "bucket" ] }, "externalId": { "description": "External identifier.", "examples": [ "f47ac10b-58cc-4372-a567-0e02b2c3d479" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "region": { "description": "Region.", "examples": [ "us-west-2" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "roleArn": { "description": "The role arn.", "examples": [ "arn:aws:iam::123456789012:role/CoralogixArchive" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "SPParameters": { "title": "Service Provider Parameters", "type": "object", "properties": { "assertionConsumerServiceUrl": { "minLength": 0, "type": "string", "description": "The assertion consumer service url.", "examples": [ "assertion" ] }, "binding": { "minLength": 0, "type": "string", "description": "The binding.", "examples": [ "binding" ] }, "metadataUrl": { "minLength": 0, "type": "string", "description": "The metadata url.", "examples": [ "https://<...>.okta.com/app/<...>/sso/saml/metadata" ] }, "nameIdFormat": { "minLength": 0, "type": "string", "description": "The name id format.", "examples": [ "name_id" ] }, "signingCertPem": { "minLength": 0, "type": "string", "description": "The signing cert pem.", "examples": [ "certificate" ] } }, "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "SampleType": { "enum": [ "SAMPLE_TYPE_UNSPECIFIED", "SAMPLE_TYPE_MIN", "SAMPLE_TYPE_MAX" ], "type": "string", "description": "Sample type." }, "SaveContextualDataIntegrationResponse": { "title": "Save contextual data integration response", "type": "object", "properties": { "integrationId": { "description": "The integration id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Response returned after successfully saving a contextual data integration." }, "SaveIntegrationResponse": { "title": "Save integration response", "required": [ "integrationId" ], "type": "object", "properties": { "integrationId": { "description": "The integration id.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Response returned after successfully saving an integration deployment." }, "ScaleType": { "enum": [ "SCALE_TYPE_UNSPECIFIED", "SCALE_TYPE_LINEAR", "SCALE_TYPE_LOGARITHMIC" ], "type": "string", "description": "Scale type." }, "Schedule": { "required": [ "scheduleOperation" ], "type": "object", "oneOf": [ { "required": [ "oneTime" ], "type": "object" }, { "required": [ "recurring" ], "type": "object" } ], "properties": { "oneTime": { "$ref": "#/components/schemas/OneTime" }, "recurring": { "$ref": "#/components/schemas/Recurring" }, "scheduleOperation": { "$ref": "#/components/schemas/ScheduleOperation" } }, "description": "Schedule." }, "ScheduleOperation": { "enum": [ "SCHEDULE_OPERATION_UNSPECIFIED", "SCHEDULE_OPERATION_MUTE", "SCHEDULE_OPERATION_ACTIVATE" ], "type": "string", "description": "Schedule operation." }, "ScopeUpdate": { "title": "ScopeUpdate", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/ScopeUpdateAction" } }, "description": "Update the scope assigned to the group. Either reference an existing scope by ID or clear the scope.", "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "ScopeUpdateAction": { "required": [ "actionType" ], "type": "object", "oneOf": [ { "required": [ "setScopeId" ], "type": "object" }, { "required": [ "clear" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "setScopeId" ], "type": "object" }, { "required": [ "clear" ], "type": "object" } ] } } ], "properties": { "actionType": { "minLength": 0, "type": "string", "description": "Discriminator indicating the scope update action type (set_scope_id or clear)." }, "clear": { "allOf": [ { "$ref": "#/components/schemas/ClearScope" } ], "description": "The clear." }, "setScopeId": { "$ref": "#/components/schemas/SetScopeId" } }, "description": "Set scope id.", "discriminator": { "propertyName": "actionType" } }, "SearchCustomEnrichmentDataResponse": { "type": "object", "properties": { "customEnrichmentsData": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CustomEnrichmentData" }, "description": "The custom enrichments data." } }, "description": "Response containing custom enrichment data search results." }, "SearchQuery": { "title": "SearchQuery", "required": [ "query" ], "type": "object", "properties": { "query": { "description": "Query string.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "syntaxType": { "$ref": "#/components/schemas/SyntaxType", "default": "SYNTAX_TYPE_LUCENE" } }, "description": "Search query." }, "SearchUsersResponse": { "title": "SearchUsersResponse", "type": "object", "properties": { "nextPageToken": { "description": "Token for the next page of results. Empty if no more pages available.", "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "totalCount": { "minimum": 0, "type": "integer", "description": "Total number of users matching the search criteria across all pages", "format": "int64" }, "users": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/rbac.v2.User" }, "description": "List of users matching the search criteria" } }, "description": "Response containing a paginated list of users matching the search criteria, along with pagination tokens and total count.", "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/" } }, "Section": { "type": "object", "properties": { "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Section unique identifier" }, "options": { "allOf": [ { "$ref": "#/components/schemas/SectionOptions" } ], "description": "Section's options" }, "rows": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Row" }, "description": "Definition of a section's rows (one row represents a single row of visualizations)" } } }, "SectionColor": { "type": "object", "properties": { "predefined": { "$ref": "#/components/schemas/SectionPredefinedColor" } }, "description": "Section color." }, "SectionOptions": { "type": "object", "oneOf": [ { "required": [ "internal" ], "type": "object" }, { "required": [ "custom" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "internal" ], "type": "object" }, { "required": [ "custom" ], "type": "object" } ] } } ], "properties": { "custom": { "allOf": [ { "$ref": "#/components/schemas/CustomSectionOptions" } ], "description": "Options for a custom section" }, "internal": { "$ref": "#/components/schemas/InternalSectionOptions" } }, "description": "Section options." }, "SectionPredefinedColor": { "enum": [ "SECTION_PREDEFINED_COLOR_UNSPECIFIED", "SECTION_PREDEFINED_COLOR_CYAN", "SECTION_PREDEFINED_COLOR_GREEN", "SECTION_PREDEFINED_COLOR_BLUE", "SECTION_PREDEFINED_COLOR_PURPLE", "SECTION_PREDEFINED_COLOR_MAGENTA", "SECTION_PREDEFINED_COLOR_PINK", "SECTION_PREDEFINED_COLOR_ORANGE" ], "type": "string", "description": "Section predefined color." }, "SelectedAllValue": { "type": "object", "additionalProperties": false, "description": "Selected all value." }, "SelectedFilters": { "type": "object", "properties": { "filters": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/views.v1.Filter" }, "description": "List of filters." } }, "description": "Selected filters." }, "SelectionType": { "enum": [ "SELECTION_TYPE_UNSPECIFIED", "SELECTION_TYPE_MULTI_ALL", "SELECTION_TYPE_MULTI", "SELECTION_TYPE_SINGLE" ], "type": "string", "description": "Selection type." }, "SelectionValue": { "title": "Selection value", "type": "object", "properties": { "defaultValue": { "description": "The default value.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "options": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Options." }, "description": "Options." } }, "description": "Selection value." }, "SendLogConfig": { "title": "Send log configuration", "required": [ "payload" ], "type": "object", "properties": { "payload": { "description": "Raw payload data.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "uuid": { "description": "UUID. Required on Create and Update.", "examples": [ "d838cd7b-087b-40c6-bc33-80997020f5d0" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Send log config." }, "SensitiveDataPlaceholder": { "title": "Sensitive data placeholder", "type": "object", "additionalProperties": false, "description": "Sensitive data placeholder." }, "ServiceNow": { "title": "ServiceNow resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved through a ServiceNow integration." }, "ServiceNowActor": { "title": "Service Now actor", "type": "object", "properties": { "coralogixUserId": { "description": "If the Service Now user is linked to a Coralogix user, this field contains the Coralogix user ID.", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ], "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", "x-coralogix-presence": true }, "id": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "User ID", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ] }, "userEmail": { "description": "Mail of the user", "examples": [ "example@coralogix.com" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "username": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Username" } }, "description": "Information about the user who initiated the action in Service Now platform" }, "SetCompanyModelPricingResponse": { "type": "object", "properties": { "pricing": { "allOf": [ { "$ref": "#/components/schemas/CompanyModelPricing" } ], "description": "The updated company model pricing." } }, "description": "Response containing the updated company model pricing." }, "SetCustomPresetAsDefaultResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after setting a custom preset as the default." }, "SetIDPParametersResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully setting the identity provider parameters." }, "SetPresetAsDefaultResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after setting a preset as the default." }, "SetPriorityOverrideResponse": { "title": "Set priority override response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after applying the priority override." } }, "description": "Response containing the case with its updated priority override." }, "SetRoleByName": { "required": [ "value" ], "type": "object", "properties": { "value": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the role to assign to this group, as an alternative to `setRoleId`. Resolved against this team's custom roles and the global built-in roles. Matching is case-insensitive. The response reports the resolved role's id and canonical name." } }, "description": "Set role by name." }, "SetRoleId": { "type": "object", "properties": { "value": { "minimum": 0, "type": "integer", "description": "The value.", "format": "int64" } }, "description": "Set role id." }, "SetScopeId": { "type": "object", "properties": { "value": { "minLength": 0, "type": "string", "description": "The value." } }, "description": "Set scope id." }, "SeverityConstraint": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/Value" } ], "description": "The value." } }, "description": "Severity constraint." }, "SexismConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the Sexism evaluation (no fields)." }, "SingleBooleanValue": { "title": "Single boolean value", "type": "object", "properties": { "defaultValue": { "description": "The default value.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Single boolean value." }, "SingleStringValue": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/StringValueLabel" } ], "description": "The value." } }, "description": "Single string value." }, "SingleValue": { "title": "Single value", "type": "object", "properties": { "defaultValue": { "description": "The default value.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Single value." }, "Slack": { "title": "Slack resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved through a Slack integration." }, "SlackActor": { "title": "Slack actor", "type": "object", "properties": { "coralogixUserId": { "description": "If the Slack user is linked to a Coralogix user, this field contains the Coralogix user ID.", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ], "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", "x-coralogix-presence": true }, "displayName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack display name", "examples": [ "John Doe" ] }, "slackUserId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack user ID", "examples": [ "U012AB3CD" ] }, "userEmail": { "description": "Email of the Slack user", "examples": [ "john.doe@example.com" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Information about the Slack user who initiated the action." }, "SlackCommentMetadata": { "title": "Slack comment metadata", "type": "object", "properties": { "channelId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack channel ID", "examples": [ "C012AB3CD" ] }, "threadId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack thread ID", "examples": [ "1234567890.123456" ] }, "userEmail": { "description": "Email of the Slack user", "examples": [ "john.doe@example.com" ], "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "userId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack user ID", "examples": [ "U012AB3CD" ] }, "workspaceId": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Slack workspace ID", "examples": [ "T012AB3CD" ] } }, "description": "Comment case event." }, "SlackConfig": { "title": "Slack configuration", "type": "object", "properties": { "attachments": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "description": "Attachments. The service keeps one item per type and does not preserve order. If omitted on update, this list is cleared." }, "digests": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Digest" }, "description": "Digests. The service keeps one item per type and does not preserve order. If omitted on update, this list is cleared." } }, "description": "Slack config." }, "Slo": { "title": "Slo", "required": [ "name", "sloTimeFrame" ], "type": "object", "oneOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "requestBasedMetricSli" ], "type": "object" }, { "required": [ "windowBasedMetricSli" ], "type": "object" }, { "required": [ "apmSli" ], "type": "object" } ] } } ], "properties": { "apmSli": { "$ref": "#/components/schemas/ApmSli" }, "apmSliMetadata": { "allOf": [ { "$ref": "#/components/schemas/ApmSli" } ], "description": "Server copy of apmSli for APM SLOs. Set by the server; sending it instead of apmSli is rejected.", "readOnly": true }, "createTime": { "description": "RFC3339 timestamp of when the SLO was created. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "creator": { "description": "Email or identifier of the user who created the SLO. Set by the server; a value sent by the client is ignored.", "examples": [ "test@domain.com" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description of the SLO.", "examples": [ "A brief description of my SLO" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "grouping": { "allOf": [ { "$ref": "#/components/schemas/v1.Grouping" } ], "description": "Grouping labels derived by the server from the SLI. A value sent by the client is rejected.", "readOnly": true }, "id": { "description": "Unique identifier of the SLO.", "examples": [ "b11919d5-ef85-4bb1-8655-02640dbe94d9" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "labels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "List of labels." }, "name": { "minLength": 1, "type": "string", "description": "Human-readable display name for the SLO. Required. A missing or empty name is rejected.", "examples": [ "Example Slo Name" ] }, "ownershipTags": { "allOf": [ { "$ref": "#/components/schemas/SloOwnershipTags" } ], "description": "Service, environment, and team ownership configuration for the SLO group and its permutations." }, "productType": { "allOf": [ { "$ref": "#/components/schemas/SloProductType" } ], "description": "Product type: APM for application performance monitoring SLOs, UNSPECIFIED for manual/custom SLOs", "examples": [ "SLO_PRODUCT_TYPE_APM" ], "x-coralogix-presence": true }, "requestBasedMetricSli": { "$ref": "#/components/schemas/RequestBasedMetricSli" }, "revision": { "allOf": [ { "$ref": "#/components/schemas/v1.Revision" } ], "description": "Revision of the SLO. Set by the server; a value sent by the client is ignored.", "readOnly": true }, "sloTimeFrame": { "allOf": [ { "$ref": "#/components/schemas/SloTimeFrame" } ], "description": "Rolling evaluation window (fixed-duration lookback)." }, "sloType": { "allOf": [ { "$ref": "#/components/schemas/SloType" } ], "description": "SLO type derived by the server from the SLI. A window-based metric SLI still reads SLO_TYPE_REQUEST. A value sent by the client must match the SLI type; a different value is rejected.", "examples": [ "SLO_TYPE_REQUEST" ], "readOnly": true, "x-coralogix-presence": true }, "targetThresholdPercentage": { "type": "number", "description": "Target compliance percentage threshold for the SLO (e.g., 99.9 for three nines).", "format": "float", "examples": [ 99.999 ] }, "type": { "deprecated": true, "description": "Deprecated: SLO type string. Set by the server from the SLI; a value sent by the client is ignored.", "examples": [ "request" ], "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "updateTime": { "description": "Timestamp of the last update. Set by the server; a value sent by the client is ignored.", "format": "date-time", "minLength": 0, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "windowBasedMetricSli": { "$ref": "#/components/schemas/WindowBasedMetricSli" } }, "description": "Definition of an SLO" }, "SloAlertValidityResult": { "type": "object", "properties": { "alertVersionId": { "minLength": 0, "type": "string", "description": "The alert version id." }, "errorMessage": { "description": "The error message.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "id": { "minLength": 0, "type": "string", "description": "Unique identifier." }, "name": { "minLength": 0, "type": "string", "description": "Display name." } } }, "SloConstantFilterField": { "enum": [ "SLO_CONST_FILTER_FIELD_UNSPECIFIED", "SLO_CONST_FILTER_FIELD_USER_NAME", "SLO_CONST_FILTER_FIELD_SLO_NAME" ], "type": "string", "description": "Slo constant filter field." }, "SloExecutionRequest": { "title": "SloExecutionRequest", "type": "object", "oneOf": [ { "required": [ "createSloRequest" ], "type": "object" }, { "required": [ "replaceSloRequest" ], "type": "object" }, { "required": [ "deleteSloRequest" ], "type": "object" } ], "properties": { "createSloRequest": { "$ref": "#/components/schemas/CreateSloRequest" }, "deleteSloRequest": { "$ref": "#/components/schemas/DeleteSloRequest" }, "replaceSloRequest": { "$ref": "#/components/schemas/ReplaceSloRequest" } }, "description": "Request for executing an SLO operation." }, "SloExecutionResponse": { "title": "SloExecutionResponse", "type": "object", "oneOf": [ { "required": [ "createSloResponse" ], "type": "object" }, { "required": [ "replaceSloResponse" ], "type": "object" }, { "required": [ "deleteSloResponse" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "createSloResponse" ], "type": "object" }, { "required": [ "replaceSloResponse" ], "type": "object" }, { "required": [ "deleteSloResponse" ], "type": "object" } ] } } ], "properties": { "createSloResponse": { "$ref": "#/components/schemas/CreateSloResponse" }, "deleteSloResponse": { "$ref": "#/components/schemas/DeleteSloResponse" }, "replaceSloResponse": { "$ref": "#/components/schemas/ReplaceSloResponse" } }, "description": "Response for an executed SLO operation." }, "SloLink": { "title": "SLO link", "type": "object", "properties": { "slo": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "SLO overview URL with the permutation preselected." } }, "description": "Deep link to the SLO overview for an alert indicator on a case." }, "SloOwnershipTag": { "title": "SloOwnershipTag", "type": "object", "properties": { "labelKeys": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Metric label names to use as sources (label-driven). Actual values come from series at query time. Empty if not using label-driven for this dimension." }, "description": "Metric label names to use as sources (label-driven). Actual values come from series at query time. Empty if not using label-driven for this dimension.", "examples": [ [ "deployment_environment", "k8s_namespace" ] ] }, "resolvedValues": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Flat, deduplicated union of staticValues and the values resolved from labelKeys across observed permutations (empties excluded). Empty when neither source yields any value. Set by the server; a value sent by the client is ignored." }, "description": "Flat, deduplicated union of staticValues and the values resolved from labelKeys across observed permutations (empties excluded). Empty when neither source yields any value. Set by the server; a value sent by the client is ignored.", "readOnly": true, "examples": [ [ "checkout-api", "production", "staging", "payments-ns" ] ] }, "staticValues": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Group-wide static values (broad). Empty if not using broad for this dimension." }, "description": "Group-wide static values (broad). Empty if not using broad for this dimension.", "examples": [ [ "checkout-api" ] ] } }, "description": "Ownership for one dimension (service, environment, or team). static_values are group-wide (broad) assignments. label_keys are metric label names whose values are read per permutation (label-driven). Both may be set; when both lists are empty, that dimension is unset." }, "SloOwnershipTags": { "title": "SloOwnershipTags", "type": "object", "properties": { "environment": { "$ref": "#/components/schemas/SloOwnershipTag" }, "service": { "$ref": "#/components/schemas/SloOwnershipTag" }, "team": { "$ref": "#/components/schemas/SloOwnershipTag" } }, "description": "Service, environment, and team ownership for the SLO group. At most one SloOwnershipTag per dimension; omit a dimension when unset." }, "SloProductType": { "enum": [ "SLO_PRODUCT_TYPE_UNSPECIFIED", "SLO_PRODUCT_TYPE_APM" ], "type": "string", "description": "Slo product type." }, "SloThresholdCondition": { "title": "SLO Threshold Condition", "type": "object", "properties": { "threshold": { "description": "Threshold value.", "format": "double", "minimum": 0, "type": "number", "x-coralogix-presence": true } }, "description": "Condition for the SLO threshold rule" }, "SloThresholdRule": { "title": "SLO Threshold Rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/SloThresholdCondition" } ], "description": "Condition for the SLO threshold rule" }, "override": { "allOf": [ { "$ref": "#/components/schemas/AlertDefOverride" } ], "description": "The override settings for the alert" } }, "description": "SLO threshold rule definition" }, "SloThresholdType": { "title": "SLO Threshold Type", "type": "object", "oneOf": [ { "required": [ "errorBudget" ], "type": "object" }, { "required": [ "burnRate" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "errorBudget" ], "type": "object" }, { "required": [ "burnRate" ], "type": "object" } ] } } ], "properties": { "burnRate": { "allOf": [ { "$ref": "#/components/schemas/BurnRateThreshold" } ], "description": "Burn rate threshold" }, "errorBudget": { "allOf": [ { "$ref": "#/components/schemas/ErrorBudgetThreshold" } ], "description": "Error budget threshold" }, "sloDefinition": { "allOf": [ { "$ref": "#/components/schemas/v3.SloDefinition" } ], "description": "SLO definition" } }, "description": "SLO threshold type definition" }, "SloTimeFrame": { "enum": [ "SLO_TIME_FRAME_UNSPECIFIED", "SLO_TIME_FRAME_1_DAY", "SLO_TIME_FRAME_7_DAYS", "SLO_TIME_FRAME_14_DAYS", "SLO_TIME_FRAME_21_DAYS", "SLO_TIME_FRAME_28_DAYS", "SLO_TIME_FRAME_30_DAYS" ], "type": "string", "description": "Slo time frame." }, "SloType": { "enum": [ "SLO_TYPE_REQUEST", "SLO_TYPE_WINDOW" ], "type": "string", "description": "Slo type." }, "SortByCategory": { "type": "object", "additionalProperties": false, "description": "Sort by category." }, "SortByQueryValue": { "type": "object", "properties": { "queryId": { "description": "Reference to the query id from Dynamic.query_display_settings", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Sort by query value." }, "SortByType": { "enum": [ "SORT_BY_TYPE_UNSPECIFIED", "SORT_BY_TYPE_VALUE", "SORT_BY_TYPE_NAME" ], "type": "string", "description": "Sort by type." }, "SortStrategy": { "title": "SortStrategy", "type": "object", "oneOf": [ { "required": [ "category" ], "type": "object" }, { "required": [ "queryValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "category" ], "type": "object" }, { "required": [ "queryValue" ], "type": "object" } ] } } ], "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/SortByCategory" } ], "description": "Order by category (e.g. bar label)" }, "queryValue": { "allOf": [ { "$ref": "#/components/schemas/SortByQueryValue" } ], "description": "Order by values from a specific query" }, "strategyType": { "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Discriminator field - STRATEGY_TYPE_CATEGORY or STRATEGY_TYPE_QUERY_VALUE", "examples": [ "STRATEGY_TYPE_CATEGORY" ] } }, "description": "Strategy for determining sort key", "discriminator": { "propertyName": "strategyType" } }, "SourceMapMetadata": { "title": "Source map metadata", "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "isUploadedSuccessful": { "description": "The is uploaded successful.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Source map metadata." }, "SpanField": { "type": "object", "oneOf": [ { "required": [ "metadataField" ], "type": "object" }, { "required": [ "tagField" ], "type": "object" }, { "required": [ "processTagField" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metadataField" ], "type": "object" }, { "required": [ "tagField" ], "type": "object" }, { "required": [ "processTagField" ], "type": "object" } ] } } ], "properties": { "metadataField": { "$ref": "#/components/schemas/MetadataField" }, "processTagField": { "description": "Name of a process-level tag field to use as the data source.", "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "tagField": { "description": "Name of a span tag field to use as the data source.", "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Span field." }, "SpanFieldSource": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "The value." } }, "description": "Span field source." }, "SpanObservationField": { "type": "object", "properties": { "keypath": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The keypath." }, "description": "The keypath." }, "relationType": { "$ref": "#/components/schemas/SpanRelationType" }, "scope": { "$ref": "#/components/schemas/DatasetScope" } }, "description": "Span observation field." }, "SpanRelationType": { "enum": [ "SPAN_RELATION_TYPE_NONE_UNSPECIFIED", "SPAN_RELATION_TYPE_OTHER", "SPAN_RELATION_TYPE_PARENT", "SPAN_RELATION_TYPE_ROOT" ], "type": "string", "description": "Span relation type." }, "SpanRules": { "type": "object", "properties": { "actionRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "dpxlExpression": { "description": "The DataPrime expression that selects the spans. It starts with a version tag, for example ` $l.serviceName == 'checkout'`. The service rejects it next to an application, subsystem, service, action, or tag rule.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "serviceRule": { "$ref": "#/components/schemas/quota.v1.Rule" }, "tagRules": { "description": "The tag rules. The service does not keep their order.", "items": { "$ref": "#/components/schemas/TagRule" }, "maxItems": 100, "minItems": 0, "type": "array", "x-coralogix-collection": "set" } }, "description": "Span rules." }, "Spans": { "title": "SpansQuery", "type": "object", "properties": { "aggregation": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LogsAggregation" }, "description": "Span query aggregation function" }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type" }, "filters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansFilter" }, "description": "List of span query filters" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of fields to group the records by" }, "luceneQuery": { "allOf": [ { "$ref": "#/components/schemas/LuceneQuery" } ], "description": "Lucene query string to search span records" } }, "description": "A spans variant of the query" }, "SpansAggregation": { "type": "object", "oneOf": [ { "required": [ "metricAggregation" ], "type": "object" }, { "required": [ "dimensionAggregation" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "metricAggregation" ], "type": "object" }, { "required": [ "dimensionAggregation" ], "type": "object" } ] } } ], "properties": { "dimensionAggregation": { "$ref": "#/components/schemas/DimensionAggregation" }, "metricAggregation": { "$ref": "#/components/schemas/MetricAggregation" } }, "description": "Spans aggregation." }, "SpansFilter": { "title": "SpansFilter", "type": "object", "properties": { "field": { "allOf": [ { "$ref": "#/components/schemas/SpanField" } ], "description": "The span field to which the filter is applied." }, "observationField": { "allOf": [ { "$ref": "#/components/schemas/SpanObservationField" } ], "description": "The observation span field to which the filter is applied. Relation type is only supported in spans widget filters. (Not supported in global dashboard filters)" }, "operator": { "allOf": [ { "$ref": "#/components/schemas/Filter.Operator" } ], "description": "An operator used for filtering the spans." } } }, "SpansPolicySettings": { "title": "Spans Source Policy", "type": "object", "properties": { "defaultPriority": { "$ref": "#/components/schemas/quota.v1.Priority" } } }, "SpansQuery.Aggregation": { "type": "object", "properties": { "aggregation": { "allOf": [ { "$ref": "#/components/schemas/SpansAggregation" } ], "description": "Type of spans aggregation function" }, "id": { "description": "Aggregation unique identifier", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "isVisible": { "description": "Whether the aggregation is visible in the table", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Aggregation name", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "SpansQuery.Grouping": { "type": "object", "properties": { "aggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpansQuery.Aggregation" }, "description": "List of aggregations applied to span records" }, "groupBy": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanField" }, "description": "List of field names to group the span records" }, "groupBys": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SpanObservationField" }, "description": "A list of observation fields definitions to group the records by" } }, "description": "Grouping configuration for span query results, defining group-by fields and aggregation functions." }, "SpansSource": { "type": "object", "properties": { "dataModeType": { "$ref": "#/components/schemas/v1.common.DataModeType" }, "labelFields": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The label fields." }, "luceneQuery": { "$ref": "#/components/schemas/LuceneQuery" }, "messageTemplate": { "description": "The message template.", "maxLength": 1000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "strategy": { "$ref": "#/components/schemas/SpansSource.Strategy" } }, "description": "Spans source." }, "SpansSource.Strategy": { "type": "object", "oneOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "instant" ], "type": "object" }, { "required": [ "range" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ] } } ], "properties": { "duration": { "allOf": [ { "$ref": "#/components/schemas/SpansSource.Strategy.Duration" } ], "description": "Duration." }, "instant": { "$ref": "#/components/schemas/SpansSource.Strategy.Instant" }, "range": { "$ref": "#/components/schemas/SpansSource.Strategy.Range" } }, "description": "Determines the time strategy for fetching spans (instant snapshot, fixed range, or sliding window)." }, "SpansSource.Strategy.Duration": { "type": "object", "properties": { "durationField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Duration strategy: uses a start timestamp and a duration field to define the annotation span." }, "SpansSource.Strategy.Instant": { "type": "object", "properties": { "timestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Instant snapshot strategy: uses a single timestamp field to define the annotation point." }, "SpansSource.Strategy.Range": { "type": "object", "properties": { "endTimestampField": { "$ref": "#/components/schemas/ObservationField" }, "startTimestampField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Range strategy: uses start and end timestamp fields to define the annotation span." }, "SqlAllowedTablesConfig": { "required": [ "tables" ], "type": "object", "properties": { "tables": { "description": "SQL table names that are allowed.", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "SQL table names that are allowed." }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the SqlAllowedTables evaluation." }, "SqlHallucinationConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the SqlHallucination evaluation (no fields)." }, "SqlLoadConfig": { "type": "object", "properties": { "allowRecursiveCte": { "type": "boolean", "description": "Whether recursive CTEs are allowed." }, "cteLimit": { "maxLength": 4, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Maximum CTEs allowed in a query." }, "joinLimit": { "maxLength": 4, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Maximum JOINs allowed in a query." } }, "description": "Configuration for the SqlLoad evaluation: caps on query complexity." }, "SqlReadOnlyConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the SqlReadOnly evaluation (no fields)." }, "SqlRestrictedTablesConfig": { "required": [ "tables" ], "type": "object", "properties": { "tables": { "description": "SQL table names that are not allowed.", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "description": "SQL table names that are not allowed." }, "maxItems": 1024, "minItems": 1, "type": "array", "uniqueItems": true, "x-coralogix-collection": "set" } }, "description": "Configuration for the SqlRestrictedTables evaluation." }, "StartTimeMetric": { "type": "object", "additionalProperties": false, "description": "Start time metric." }, "Stat": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "customUnit": { "description": "Custom unit (requires to have unit field set as UNIT_CUSTOM to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 2 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "displaySeriesName": { "description": "(multi-stat display only) Whether to show the series names above the value", "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "Indicates how to group the legend elements, either by thresholds or by query groups" }, "max": { "description": "A maximum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 150000 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 0 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "thresholdBy": { "allOf": [ { "$ref": "#/components/schemas/common.ThresholdBy" } ], "description": "Indicates which widget element should be colorized as the threshold, either the value or the background" }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of value thresholds, each with a certain color and an optional name label" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or 'custom'", "examples": [ "3" ] }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "deprecated": true }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The value fields." } }, "description": "Stat." }, "StatCard": { "title": "StatCard", "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "Fields to use for categorizing the stat card data" }, "colorLabelMapping": { "allOf": [ { "$ref": "#/components/schemas/ColorLabelMapping" } ], "description": "Color and label mapping configuration for the stat card values" }, "customUnit": { "description": "Custom unit (requires to have unit field set as UNIT_CUSTOM to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 2 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "label": { "allOf": [ { "$ref": "#/components/schemas/StatVisualElement" } ], "description": "Optional label display configuration" }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "Indicates how to group the legend elements, either by thresholds or by query groups" }, "primaryValue": { "allOf": [ { "$ref": "#/components/schemas/StatVisualElement" } ], "description": "Primary value display configuration (required)" }, "title": { "allOf": [ { "$ref": "#/components/schemas/StatVisualElement" } ], "description": "Optional title display configuration" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or 'custom'", "examples": [ "3" ] }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "Fields to use for the stat card value" } }, "description": "Stat card visualization displaying key values with color mapping and configurable visual elements" }, "StatVisualElement": { "title": "StatVisualElement", "type": "object", "oneOf": [ { "required": [ "observationField" ], "type": "object" }, { "required": [ "mappedValues" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "observationField" ], "type": "object" }, { "required": [ "mappedValues" ], "type": "object" } ] } } ], "properties": { "mappedValues": { "allOf": [ { "$ref": "#/components/schemas/MappedValues" } ], "description": "Display the result of the color label mapping" }, "observationField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "A field from the query datashape to display" }, "templateText": { "description": "Optional display name template with variable support, e.g. 'pod count: {{$d.k8s.pods}}' or '{{$mapped}}'", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "templateVariables": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DisplayNameTemplateVariable" }, "description": "Variables available for use in the display name template, each referencing either a datashape field or mapped values" } }, "description": "A configurable display element that can show either a query field value or the result of color label mapping, with an optional display name template" }, "StaticSource": { "required": [ "values", "valuesOrderDirection", "allOption" ], "type": "object", "properties": { "allOption": { "$ref": "#/components/schemas/AllOption" }, "values": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ValueLabel" }, "description": "List of values." }, "valuesOrderDirection": { "allOf": [ { "$ref": "#/components/schemas/OrderDirection" } ], "description": "Values sort order. A concrete value is required — ORDER_DIRECTION_UNSPECIFIED is rejected." } }, "description": "Static source — a fixed list of values defined directly on the variable. valuesOrderDirection is required and must be a concrete value — ORDER_DIRECTION_UNSPECIFIED is rejected." }, "StatusAggregation": { "title": "Status aggregation", "type": "object", "properties": { "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Number of cases with this status", "format": "int64" }, "status": { "allOf": [ { "$ref": "#/components/schemas/CaseStatus" } ], "description": "Case status" } }, "description": "Count of cases grouped by case status." }, "StatusChangedCaseEvent": { "title": "Status changed event", "type": "object", "properties": { "newStatus": { "allOf": [ { "$ref": "#/components/schemas/CaseStatus" } ], "description": "New status", "examples": [ "CASE_STATUS_ACKNOWLEDGED" ] }, "oldStatus": { "allOf": [ { "$ref": "#/components/schemas/CaseStatus" } ], "description": "Previous status", "examples": [ "CASE_STATUS_ACTIVE" ] } }, "description": "Status changed case event." }, "StatusCount": { "title": "Status count", "type": "object", "properties": { "count": { "description": "The count for this alert status", "examples": [ 15 ], "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/AlertDefStatus" } ], "description": "The alert status", "examples": [ "ALERT_DEF_STATUS_ALERTING" ] } }, "description": "Count for a specific alert status" }, "StringList": { "title": "String list", "type": "object", "properties": { "values": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of values." }, "description": "List of values." } }, "description": "String list." }, "StringValueLabel": { "type": "object", "properties": { "label": { "description": "The label.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "String value label." }, "StringValues": { "type": "object", "properties": { "values": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The values." }, "description": "The values." } }, "description": "String values." }, "SubsystemNameConstraint": { "type": "object", "properties": { "value": { "description": "The value.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Subsystem name constraint." }, "Sum": { "type": "object", "properties": { "field": { "description": "The field.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "observationField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Sum." }, "SuspiciousIpType": { "type": "object", "additionalProperties": false, "description": "Suspicious ip type." }, "SyncExternalCaseEventsResponse": { "title": "Sync external Case events response", "required": [ "syncRegistered" ], "type": "object", "properties": { "syncRegistered": { "type": "boolean", "description": "Indicates whether the sync was successfully registered" } }, "description": "Response returned after syncing external case events." }, "SyncRumDataResponse": { "title": "Sync RUM data response", "type": "object", "properties": { "syncExecuted": { "description": "The sync executed.", "type": "boolean", "x-coralogix-presence": true }, "syncedAt": { "description": "The synced at.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Response returned after syncing RUM data." }, "SyntaxType": { "enum": [ "SYNTAX_TYPE_UNSPECIFIED", "SYNTAX_TYPE_LUCENE", "SYNTAX_TYPE_DATAPRIME" ], "type": "string", "description": "Syntax type." }, "System": { "title": "System resolver", "type": "object", "additionalProperties": false, "description": "Marker indicating that the case was resolved automatically by the Cases system." }, "SystemActor": { "title": "System actor", "type": "object", "additionalProperties": false, "description": "Empty message indicating system-initiated action." }, "SystemRole": { "type": "object", "properties": { "description": { "minLength": 0, "type": "string", "description": "Human-readable description." }, "name": { "minLength": 0, "type": "string", "description": "Display name." }, "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions." }, "description": "List of permissions." }, "roleId": { "minimum": 0, "type": "integer", "description": "The role id.", "format": "int64" } } }, "Table": { "type": "object", "properties": { "columns": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Table.Column" }, "description": "List of columns." }, "rules": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Table.Rule" }, "description": "List of rules." }, "settings": { "$ref": "#/components/schemas/TableSettings" } }, "description": "Visualization configuration for displaying query results as a structured table with columns, rules, and display settings." }, "Table.Column": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/ObservationField" } } }, "Table.Rule": { "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Unique identifier." }, "name": { "description": "Display name.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "properties": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Property" }, "description": "The properties." }, "ruleScope": { "$ref": "#/components/schemas/RuleScope" } }, "description": "Rule." }, "TableSettings": { "type": "object", "properties": { "columnWidths": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ColumnWidthEntry" }, "description": "List of configured column widths" }, "rowStyle": { "allOf": [ { "$ref": "#/components/schemas/RowStyle" } ], "description": "Type of row view style in the table", "examples": [ "1" ] } }, "description": "Table settings." }, "TagRule": { "title": "Tag Rule", "required": [ "ruleTypeId", "tagName", "tagValue" ], "type": "object", "properties": { "ruleTypeId": { "allOf": [ { "$ref": "#/components/schemas/RuleTypeId" } ], "examples": [ "rule_type_id" ] }, "tagName": { "description": "The tag name. Must start with \"tags.\".", "examples": [ "tags.environment" ], "maxLength": 255, "minLength": 1, "pattern": "^tags\\..*$", "type": "string", "x-coralogix-presence": true }, "tagValue": { "description": "The tag value(s) to match. For IS and IS_NOT rules, up to 50 comma-separated values.", "examples": [ "tag_value" ], "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Tag rule for a policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "TargetDomain": { "enum": [ "ACTION", "ALERT", "ENRICHMENT", "GRAFANA_DASHBOARD", "KIBANA_DASHBOARD", "PARSING_RULE", "SAVED_VIEW", "CX_CUSTOM_DASHBOARD", "METRICS_RULE_GROUP", "EVENTS_TO_METRICS", "ALERT_V3" ], "type": "string", "description": "Target domain." }, "TargetFormat": { "enum": [ "TARGET_FORMAT_UNSPECIFIED", "TARGET_FORMAT_CX_DATA_V1" ], "type": "string", "description": "Target format." }, "TeamGroup": { "title": "TeamGroup", "type": "object", "properties": { "createdAt": { "description": "Creation timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Group description", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "externalId": { "description": "Group external identifier. Applies if team is externally defined.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "groupId": { "minimum": 0, "type": "integer", "description": "Unique team group identifier", "format": "int64" }, "groupOrigin": { "allOf": [ { "$ref": "#/components/schemas/GroupOrigin" } ], "description": "Origin of the group: built-in (system-managed) or user-defined" }, "groupType": { "allOf": [ { "$ref": "#/components/schemas/GroupType" } ], "description": "Group type defines the level of access to the group itself" }, "name": { "minLength": 0, "type": "string", "description": "Unique name" }, "role": { "allOf": [ { "$ref": "#/components/schemas/Role" } ], "description": "Role assigned to this group" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/v2.Scope" } ], "description": "Scope assigned to this group" }, "teamId": { "minimum": 0, "type": "integer", "description": "Team this group belongs to", "format": "int64" }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "userIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "IDs of the users that are members of this group." }, "description": "IDs of the users that are members of this group." } }, "description": "A Team Group entity." }, "TemplateRenderingMode": { "enum": [ "TEMPLATE_RENDERING_MODE_UNSPECIFIED", "RELAXED", "STRICT" ], "type": "string", "description": "Template rendering mode." }, "TemplatedConnectorConfigField": { "title": "Templated Connector Config Field", "required": [ "fieldName" ], "type": "object", "properties": { "fieldName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name." }, "template": { "maxLength": 20000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Template." } }, "description": "A templated connector configuration field" }, "TemporaryAccess": { "title": "TemporaryAccess", "type": "object", "properties": { "expireAt": { "description": "Timestamp when the user's temporary access will expire. After this time, the user will no longer be able to access the system.", "examples": [ "2021-01-01T00:00:00.000Z" ], "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "User with temporary access. The user's access will automatically expire at the specified timestamp." }, "TenantConfigV2": { "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": { "disabled": { "type": "boolean", "description": "Whether metrics archiving is disabled for this tenant." }, "gcs": { "allOf": [ { "$ref": "#/components/schemas/GcsConfig" } ], "description": "Google Cloud Storage configuration." }, "ibm": { "allOf": [ { "$ref": "#/components/schemas/IbmConfigV2" } ], "description": "IBM Cloud Object Storage configuration." }, "prefix": { "minLength": 0, "type": "string", "description": "Storage path prefix applied to all archived objects." }, "retentionPolicy": { "$ref": "#/components/schemas/RetentionPolicyRequest" }, "s3": { "allOf": [ { "$ref": "#/components/schemas/S3Config" } ], "description": "AWS S3 storage configuration." }, "tenantId": { "minimum": 0, "type": "integer", "description": "Tenant identifier.", "format": "int64" } }, "description": "Tenant config v2." }, "Terraform": { "title": "Terraform", "type": "object", "properties": { "configurationBlocks": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationBlock" }, "description": "The configuration blocks." } } }, "TestConnectorConfigResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestResult" } }, "description": "Response containing the results of a connector configuration test." }, "TestContextualDataIntegrationResponse": { "title": "Test contextual data integration response", "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestIntegrationResult" } }, "description": "Response containing the results of a contextual data integration test." }, "TestDestinationResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestResult" } }, "description": "Response containing the results of a notification destination test." }, "TestExistingConnectorResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestResult" } }, "description": "Response containing the results of testing an existing connector." }, "TestExistingPresetResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestResult" } }, "description": "Response containing the results of testing an existing preset." }, "TestIntegrationResponse": { "title": "Test integration response", "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestIntegrationResult" } }, "description": "Response containing the results of an integration test." }, "TestIntegrationResult": { "title": "Test integration result", "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/v1.Failure" }, "success": { "$ref": "#/components/schemas/TestIntegrationResult.Success" } }, "description": "Test integration result." }, "TestIntegrationResult.Success": { "title": "Success", "type": "object", "additionalProperties": false, "description": "Success." }, "TestOutgoingWebhookResponse": { "title": "Test outgoing webhook response", "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/TestOutgoingWebhookResponse.Failure" }, "success": { "$ref": "#/components/schemas/TestOutgoingWebhookResponse.Success" } }, "description": "Response containing the results of an outgoing webhook test." }, "TestOutgoingWebhookResponse.Failure": { "title": "Test outgoing webhook failure", "type": "object", "properties": { "displayMessage": { "description": "The display message.", "examples": [ "example_display_message" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "errorMessage": { "description": "The error message.", "examples": [ "example_error_message" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "statusCode": { "description": "The status code.", "examples": [ 400 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Failure." }, "TestOutgoingWebhookResponse.Success": { "title": "Test outgoing webhook success", "type": "object", "additionalProperties": false, "description": "Success." }, "TestPoliciesResult": { "title": "Test Policies Result", "required": [ "metaFieldsValues", "matched", "policy" ], "type": "object", "properties": { "matched": { "description": "The matched.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "metaFieldsValues": { "$ref": "#/components/schemas/LogMetaFieldsValues" }, "policy": { "$ref": "#/components/schemas/Policy" } }, "description": "Result of testing policies.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "TestPresetConfigResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestResult" } }, "description": "Response containing the results of a notification preset configuration test." }, "TestResult": { "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/TestResult.Failure" }, "success": { "$ref": "#/components/schemas/TestResult.Success" } }, "description": "Result of a notification test, either a success or failure." }, "TestResult.Failure": { "type": "object", "properties": { "message": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message." }, "statusCode": { "description": "The status code.", "format": "int64", "maximum": 599, "minimum": 100, "type": "integer", "x-coralogix-presence": true } }, "description": "Failure." }, "TestResult.Success": { "type": "object", "properties": { "metadata": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Metadata." } }, "description": "Indicates the notification test succeeded." }, "TestRoutingConditionValidResponse": { "title": "Test Routing Condition Valid Response", "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/TestRoutingConditionValidResponse.Failure" }, "success": { "$ref": "#/components/schemas/TestRoutingConditionValidResponse.Success" } }, "description": "Response which specifies condition evaluation result or error", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "TestRoutingConditionValidResponse.Failure": { "type": "object", "properties": { "message": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message.", "examples": [ "Invalid condition: condition should be rendered to a boolean value (true or false)" ] } }, "description": "Indicates the routing condition is invalid, with a human-readable error message." }, "TestRoutingConditionValidResponse.Success": { "type": "object", "properties": { "result": { "type": "boolean", "description": "Result.", "examples": [ true ] } }, "description": "Indicates the routing condition is valid, with the evaluated result." }, "TestTemplateRenderResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TestTemplateRenderResult" } }, "description": "Response containing the results of a notification template render test." }, "TestTemplateRenderResult": { "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/TestTemplateRenderResult.Failure" }, "success": { "$ref": "#/components/schemas/TestTemplateRenderResult.Success" } }, "description": "Result of a template render test, either a success with rendered output or a failure with reason." }, "TestTemplateRenderResult.Failure": { "type": "object", "properties": { "message": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message.", "examples": [ "Template rendering failed" ] }, "reason": { "$ref": "#/components/schemas/FailureReason" } }, "description": "Indicates the template render test failed, with a message and failure reason." }, "TestTemplateRenderResult.Success": { "type": "object", "properties": { "renderedValue": { "maxLength": 50000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The rendered value.", "examples": [ "Rendered template result" ] } }, "description": "Success." }, "TextAlignment": { "enum": [ "TEXT_ALIGNMENT_UNSPECIFIED", "TEXT_ALIGNMENT_LEFT", "TEXT_ALIGNMENT_CENTER", "TEXT_ALIGNMENT_RIGHT" ], "type": "string", "description": "Text alignment." }, "TextboxDefaultIntervalValue": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Textbox default interval value." }, "TextboxDefaultLuceneValue": { "type": "object", "properties": { "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/v1.common.DataModeType" } ], "description": "Data mode. Omitted or DATA_MODE_TYPE_HIGH_UNSPECIFIED queries high-priority ('Frequent Search') data; DATA_MODE_TYPE_ARCHIVE queries archive ('Monitoring') data." }, "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Textbox default lucene value." }, "TextboxDefaultNumericValue": { "type": "object", "properties": { "isInteger": { "description": "The is integer.", "type": "boolean", "x-coralogix-presence": true }, "max": { "description": "Maximum value.", "format": "float", "type": "number", "x-coralogix-presence": true }, "min": { "description": "Minimum value.", "format": "float", "type": "number", "x-coralogix-presence": true }, "value": { "description": "The value.", "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Textbox default numeric value." }, "TextboxDefaultRegexValue": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Textbox default regex value." }, "TextboxDefaultStringValue": { "type": "object", "properties": { "value": { "description": "The value.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Textbox default string value." }, "TextboxDefaultValue": { "type": "object", "oneOf": [ { "required": [ "singleString" ], "type": "object" }, { "required": [ "singleNumeric" ], "type": "object" }, { "required": [ "defaultStringValue" ], "type": "object" }, { "required": [ "defaultNumericValue" ], "type": "object" }, { "required": [ "defaultLuceneValue" ], "type": "object" }, { "required": [ "defaultRegexValue" ], "type": "object" }, { "required": [ "defaultIntervalValue" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "singleString" ], "type": "object" }, { "required": [ "singleNumeric" ], "type": "object" }, { "required": [ "defaultStringValue" ], "type": "object" }, { "required": [ "defaultNumericValue" ], "type": "object" }, { "required": [ "defaultLuceneValue" ], "type": "object" }, { "required": [ "defaultRegexValue" ], "type": "object" }, { "required": [ "defaultIntervalValue" ], "type": "object" } ] } } ], "properties": { "defaultIntervalValue": { "$ref": "#/components/schemas/TextboxDefaultIntervalValue" }, "defaultLuceneValue": { "$ref": "#/components/schemas/TextboxDefaultLuceneValue" }, "defaultNumericValue": { "$ref": "#/components/schemas/TextboxDefaultNumericValue" }, "defaultRegexValue": { "$ref": "#/components/schemas/TextboxDefaultRegexValue" }, "defaultStringValue": { "$ref": "#/components/schemas/TextboxDefaultStringValue" }, "singleNumeric": { "deprecated": true, "description": "Deprecated. Default numeric value for the textbox variable.", "format": "float", "type": "number", "x-coralogix-presence": true }, "singleString": { "deprecated": true, "description": "Deprecated. Default string value for the textbox variable.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Textbox default value." }, "TextboxSource": { "type": "object", "properties": { "defaultValue": { "$ref": "#/components/schemas/TextboxDefaultValue" } }, "description": "Variable source backed by a free-text input box, with an optional default value." }, "ThresholdType": { "enum": [ "THRESHOLD_TYPE_UNSPECIFIED", "THRESHOLD_TYPE_RELATIVE", "THRESHOLD_TYPE_ABSOLUTE" ], "type": "string", "description": "Threshold type." }, "TimeDuration": { "title": "Time duration", "type": "object", "properties": { "duration": { "description": "The duration value", "examples": [ "24" ], "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/DurationUnit" } ], "description": "The unit of the duration", "examples": [ "DURATION_UNIT_HOURS" ] } }, "description": "Configuration for time duration" }, "TimeFrame": { "type": "object", "properties": { "from": { "description": "The from.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "to": { "description": "The to.", "format": "date-time", "maxLength": 35, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Time frame." }, "TimeFrameSelect": { "type": "object", "oneOf": [ { "required": [ "absoluteTimeFrame" ], "type": "object" }, { "required": [ "relativeTimeFrame" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "absoluteTimeFrame" ], "type": "object" }, { "required": [ "relativeTimeFrame" ], "type": "object" } ] } } ], "properties": { "absoluteTimeFrame": { "$ref": "#/components/schemas/TimeFrame" }, "relativeTimeFrame": { "description": "Relative time frame expressed as a duration offset from the current time (e.g., last 15 minutes).", "maxLength": 64, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Time frame select." }, "TimeOfDay": { "title": "Time of day", "type": "object", "properties": { "hours": { "maximum": 23, "minimum": 0, "type": "integer", "description": "The hours.", "format": "int32", "examples": [ 14 ] }, "minutes": { "maximum": 59, "minimum": 0, "type": "integer", "description": "The minutes.", "format": "int32", "examples": [ 30 ] } }, "description": "Represents a specific time in a 24-hour format" }, "TimeSelection": { "type": "object", "oneOf": [ { "required": [ "quickSelection" ], "type": "object" }, { "required": [ "customSelection" ], "type": "object" } ], "properties": { "customSelection": { "$ref": "#/components/schemas/CustomTimeSelection" }, "quickSelection": { "$ref": "#/components/schemas/QuickTimeSelection" } }, "description": "Time selection." }, "TimeSeriesBars": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "barValueDisplay": { "allOf": [ { "$ref": "#/components/schemas/Visualization.BarValueDisplay" } ], "description": "Specifies where to display the bar value", "examples": [ "1" ] }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme for this query, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxSlicesPerBar": { "description": "How many slices can fit in a single bar", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "seriesNameTemplate": { "description": "Custom template for the series name", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "sortBy": { "allOf": [ { "$ref": "#/components/schemas/SortByType" } ], "description": "Sort type, by name or by value", "examples": [ "1" ] }, "temporalField": { "$ref": "#/components/schemas/ObservationField" }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/TimeSeriesTooltip" } ], "description": "Tooltip settings for the widget" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The value fields." }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis", "x-coralogix-presence": true }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Time series bars." }, "TimeSeriesLines": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme for this query, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "connectNulls": { "description": "Whether the line should remain connected instead of producing scattered points when null values are present in between", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires to have unit field as 'custom' to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "seriesCountLimit": { "description": "Max count of the series per query", "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "x-coralogix-presence": true }, "seriesNameTemplate": { "description": "Custom template for the series name", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "stackedLine": { "allOf": [ { "$ref": "#/components/schemas/Visualization.StackedLine" } ], "description": "Type of stacked line, can be undefined, absolute or relative" }, "temporalField": { "$ref": "#/components/schemas/ObservationField" }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/TimeSeriesTooltip" } ], "description": "Tooltip settings for the widget" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "useDataTimeRange": { "description": "When used, dashboard or widget time frame is ignored and X axis will represent only dates present in received data which can differ significantly from time ranges that were requested.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The value fields." }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis", "x-coralogix-presence": true }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Time series lines." }, "TimeSeriesLinesMulti": { "type": "object", "properties": { "connectNulls": { "description": "Whether the line should remain connected instead of producing scattered points when null values are present in between", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "queryDisplaySettings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/QueryDisplaySettings" }, "description": "Definitions of widget queries" }, "stackedLine": { "allOf": [ { "$ref": "#/components/schemas/Visualization.StackedLine" } ], "description": "Type of stacked line, can be undefined, absolute or relative" }, "tooltip": { "allOf": [ { "$ref": "#/components/schemas/TimeSeriesTooltip" } ], "description": "Tooltip settings for the widget" }, "useDataTimeRange": { "description": "When used, dashboard or widget time frame is ignored and X axis will represent only dates present in received data which can differ significantly from time ranges that were requested.", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "xAxisTimeFormat": { "allOf": [ { "$ref": "#/components/schemas/XAxisTimeFormat" } ], "description": "Time format for the X axis", "x-coralogix-presence": true } }, "description": "Time series lines multi." }, "TimeSeriesTooltip": { "type": "object", "properties": { "showAllSeries": { "description": "Type of the tooltip display, can be showing single series value or all series values at once", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "showLabels": { "description": "The show labels.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Time series tooltip." }, "Timeframe": { "required": [ "timezone" ], "type": "object", "oneOf": [ { "required": [ "endTime" ], "type": "object" }, { "required": [ "duration" ], "type": "object" } ], "properties": { "duration": { "$ref": "#/components/schemas/v1.Duration" }, "endTime": { "minLength": 0, "type": "string", "description": "End time." }, "startTime": { "minLength": 0, "type": "string", "description": "Start time." }, "submittedStartTime": { "description": "The start time as submitted in the request, before the service normalized it to the next valid occurrence. Populated only in create and update responses; ignored in requests and omitted from read responses.", "maxLength": 64, "minLength": 0, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "timezone": { "minLength": 1, "type": "string", "description": "Timezone." } }, "description": "Timeframe." }, "TimeframeType": { "enum": [ "TIMEFRAME_TYPE_UNSPECIFIED", "TIMEFRAME_TYPE_UP_TO" ], "type": "string", "description": "Timeframe type." }, "TimestampRange": { "title": "TimestampRange", "required": [ "from", "to" ], "type": "object", "properties": { "from": { "description": "Inclusive start of the time range.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "to": { "description": "Inclusive end of the time range.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } } }, "TitleChangedCaseEvent": { "title": "Title changed event", "type": "object", "properties": { "from": { "maxLength": 512, "minLength": 1, "pattern": "^[\\s\\S]*\\S[\\s\\S]*$", "type": "string", "description": "Previous case title. Leading and trailing whitespace is trimmed before the length limits are applied." }, "to": { "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." } }, "description": "Title changed case event." }, "TokenOriginType": { "enum": [ "TOKEN_ORIGIN_TYPE_UNSPECIFIED", "TOKEN_ORIGIN_TYPE_USER", "TOKEN_ORIGIN_TYPE_API" ], "type": "string", "description": "Token origin type." }, "Tooltip": { "type": "object", "properties": { "showLabels": { "description": "The show labels.", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/TooltipType" } ], "description": "Type of the tooltip display, can be showing single series value or all series values at once" } }, "description": "Tooltip." }, "TooltipType": { "enum": [ "TOOLTIP_TYPE_UNSPECIFIED", "TOOLTIP_TYPE_ALL", "TOOLTIP_TYPE_SINGLE" ], "type": "string", "description": "Tooltip type." }, "ToxicityConfig": { "type": "object", "additionalProperties": false, "description": "Configuration for the Toxicity evaluation (no fields)." }, "TracingFilter": { "title": "Tracing filter", "type": "object", "properties": { "simpleFilter": { "allOf": [ { "$ref": "#/components/schemas/TracingSimpleFilter" } ], "description": "Simple filter using latency threshold and label filters" } }, "description": "Filter configuration for tracing-based alerts" }, "TracingFilterOperationType": { "enum": [ "TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED", "TRACING_FILTER_OPERATION_TYPE_INCLUDES", "TRACING_FILTER_OPERATION_TYPE_ENDS_WITH", "TRACING_FILTER_OPERATION_TYPE_STARTS_WITH", "TRACING_FILTER_OPERATION_TYPE_IS_NOT" ], "type": "string", "description": "Tracing filter operation type." }, "TracingFilterType": { "title": "Tracing filter type", "type": "object", "properties": { "operation": { "allOf": [ { "$ref": "#/components/schemas/TracingFilterOperationType" } ], "description": "The operation to perform on the label value", "examples": [ "TRACING_FILTER_OPERATION_TYPE_STARTS_WITH" ] }, "values": { "minItems": 1, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The values of the label to filter by" }, "description": "The values of the label to filter by", "examples": [ [ "value1", "value2" ] ] } }, "description": "Filter type for trace entries" }, "TracingImmediateType": { "title": "Trace-based immediate alert type", "type": "object", "properties": { "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Notification payload field filter" }, "description": "Notification payload field filter", "examples": [ [ "obj.field" ] ] }, "tracingFilter": { "allOf": [ { "$ref": "#/components/schemas/TracingFilter" } ], "description": "A filter to match trace entries for immediate alerts" } }, "description": "Configuration for immediate alerts triggered on trace entries", "externalDocs": { "description": "Learn more about trace-based alerts in our documentation.", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/traces/tracing-alerts/" } }, "TracingLabelFilters": { "title": "Tracing label filters", "type": "object", "properties": { "applicationName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TracingFilterType" }, "description": "Filter by application names" }, "operationName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TracingFilterType" }, "description": "Filter by operation names" }, "serviceName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TracingFilterType" }, "description": "Filter by service names" }, "spanFields": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TracingSpanFieldsFilterType" }, "description": "Filter by span fields" }, "subsystemName": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/TracingFilterType" }, "description": "Filter by subsystem names" } }, "description": "Filters for application name, subsystem name, service name, operation name and span fields" }, "TracingLink": { "title": "Tracing link", "type": "object", "properties": { "tracing": { "maxLength": 2048, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Explore traces URL pre-filtered to the alert query and case time window." } }, "description": "Deep link to explore traces related to an alert indicator on a case." }, "TracingSimpleFilter": { "title": "Simple tracing filter", "type": "object", "properties": { "latencyThresholdMs": { "description": "The latency threshold to filter traces in milliseconds", "examples": [ "1000" ], "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-coralogix-presence": true }, "tracingLabelFilters": { "allOf": [ { "$ref": "#/components/schemas/TracingLabelFilters" } ], "description": "Trace label filters" } }, "description": "Basic filter configuration using a latency threshold and label filters" }, "TracingSpanFieldsFilterType": { "title": "Tracing span fields filter type", "type": "object", "properties": { "filterType": { "allOf": [ { "$ref": "#/components/schemas/TracingFilterType" } ], "description": "The FilterType to filter by." }, "key": { "description": "The key of the span field to filter by", "examples": [ "span.field.key" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "A filter for span fields in trace entries" }, "TracingThresholdCondition": { "title": "Trace-based alert threshold condition", "type": "object", "properties": { "conditionType": { "allOf": [ { "$ref": "#/components/schemas/TracingThresholdConditionType" } ], "description": "The type of condition for the alert", "examples": [ "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ] }, "spanAmount": { "description": "The threshold value for the alert condition", "examples": [ 100 ], "format": "double", "minimum": 0, "type": "number", "x-coralogix-presence": true }, "timeWindow": { "allOf": [ { "$ref": "#/components/schemas/TracingTimeWindow" } ], "description": "The time window for the alert condition" } }, "description": "Tracing threshold condition." }, "TracingThresholdConditionType": { "enum": [ "TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED" ], "type": "string", "description": "Tracing threshold condition type." }, "TracingThresholdRule": { "title": "Trace Threshold Rule", "type": "object", "properties": { "condition": { "allOf": [ { "$ref": "#/components/schemas/TracingThresholdCondition" } ], "description": "The condition for the threshold alert." } }, "description": "A rule for trace-based threshold alerts" }, "TracingThresholdType": { "title": "Trace-based threshold alert type", "type": "object", "properties": { "notificationPayloadFilter": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "Notification payload field filter" }, "description": "Notification payload field filter", "examples": [ [ "obj.field" ] ] }, "rules": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/TracingThresholdRule" }, "description": "The rules for the trace threshold alert." }, "tracingFilter": { "allOf": [ { "$ref": "#/components/schemas/TracingFilter" } ], "description": "The filter to match trace entries for the alert." } }, "description": "Configuration for alerts based on trace count thresholds", "externalDocs": { "description": "Learn more about trace-based alerts in our documentation", "url": "https://coralogix.com/docs/user-guides/alerting/create-an-alert/traces/tracing-alerts/" } }, "TracingTimeWindow": { "title": "Tracing time window", "type": "object", "properties": { "tracingTimeWindowValue": { "allOf": [ { "$ref": "#/components/schemas/TracingTimeWindowValue" } ], "description": "A time window defined by a specific value", "examples": [ "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED" ] } }, "description": "Tracing time window." }, "TracingTimeWindowValue": { "enum": [ "TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED", "TRACING_TIME_WINDOW_VALUE_MINUTES_10", "TRACING_TIME_WINDOW_VALUE_MINUTES_15", "TRACING_TIME_WINDOW_VALUE_MINUTES_20", "TRACING_TIME_WINDOW_VALUE_MINUTES_30", "TRACING_TIME_WINDOW_VALUE_HOUR_1", "TRACING_TIME_WINDOW_VALUE_HOURS_2", "TRACING_TIME_WINDOW_VALUE_HOURS_4", "TRACING_TIME_WINDOW_VALUE_HOURS_6", "TRACING_TIME_WINDOW_VALUE_HOURS_12", "TRACING_TIME_WINDOW_VALUE_HOURS_24", "TRACING_TIME_WINDOW_VALUE_HOURS_36" ], "type": "string", "description": "Tracing time window value." }, "Triggered": { "title": "Triggered Prometheus alert status", "required": [ "triggeredAt" ], "type": "object", "properties": { "triggeredAt": { "description": "Timestamp when the alert was triggered.", "examples": [ "2025-09-22T10:30:00.000Z" ], "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "description": "Status payload for an active Prometheus alert." }, "TypeCount": { "title": "Type count", "type": "object", "properties": { "count": { "description": "The count for this alert type", "examples": [ 42 ], "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AlertDefType" } ], "description": "The alert type", "examples": [ "ALERT_DEF_TYPE_LOGS_THRESHOLD" ] } }, "description": "Count for a specific alert type" }, "TypeValues": { "type": "object", "properties": { "values": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/SloType" }, "description": "The values." } }, "description": "Type values." }, "UUID": { "type": "object", "properties": { "value": { "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 value." } }, "description": "Uuid." }, "UnacknowledgeCaseResponse": { "title": "Unacknowledge case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after acknowledgment was removed." } }, "description": "Response containing the case after acknowledgment was removed." }, "UnassignCaseResponse": { "title": "Unassign case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Case after removing its assignee." } }, "description": "Response containing the case after removing its assignee." }, "UnassignIncidentsResponse": { "title": "Unassign incidents response", "required": [ "incidents" ], "type": "object", "properties": { "incidents": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Incident" }, "description": "List of incidents after unassignment" } }, "description": "Response containing the updated incidents after unassignment" }, "Unassigned": { "title": "Unassigned", "type": "object", "additionalProperties": false, "description": "Marker selecting cases that have no assignee." }, "UnassignedCaseEvent": { "title": "Unassigned event", "type": "object", "properties": { "previousAssigneeUserId": { "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": "User ID that was unassigned" } }, "description": "Unassigned case event." }, "UndeployExtensionResponse": { "title": "Revert deployment of extension response", "type": "object", "properties": { "extensionDeployment": { "$ref": "#/components/schemas/ExtensionDeployment" }, "failedItems": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FailedItem" }, "description": "The failed items.", "default": [] } }, "description": "Response returned after successfully undeploying an extension." }, "UnknownAssigneeError": { "title": "Unknown assignee error", "type": "object", "properties": { "unknownAssigneeEmail": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Email of the assignee that could not be found", "examples": [ "unknown" ] } }, "description": "Change assignee failed event." }, "UnlinkCustomEvaluationFromAppResponse": { "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 that was unlinked." }, "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": "Response returned after unlinking." }, "UnpinDashboardResponse": { "title": "Unpin dashboard response data structure", "type": "object", "additionalProperties": false, "description": "This is a response received when dashboard has been unpinned", "externalDocs": { "description": "Find out more about Dashboards in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "Untracked": { "title": "Untracked", "type": "object", "additionalProperties": false }, "UpdateAiEvaluationResponse": { "required": [ "aiEvaluation" ], "type": "object", "properties": { "aiEvaluation": { "allOf": [ { "$ref": "#/components/schemas/AiEvaluation" } ], "description": "The updated AI evaluation." } }, "description": "Response returned after updating an AI evaluation." }, "UpdateAlertSchedulerRuleRequest": { "title": "Update alert scheduler rule request data structure", "required": [ "alertSchedulerRule" ], "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "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/" } }, "UpdateAlertSchedulerRuleResponse": { "title": "Create alert scheduler rule response data structure", "required": [ "alertSchedulerRule" ], "type": "object", "properties": { "alertSchedulerRule": { "$ref": "#/components/schemas/AlertSchedulerRule" } }, "description": "This is a response sent after creating 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/" } }, "UpdateApiKeyRequest.Permissions": { "title": "Permissions", "type": "object", "properties": { "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of individual permissions to grant to the API key." }, "description": "List of individual permissions to grant to the API key." } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "UpdateApiKeyResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully updating an API key." }, "UpdateApiKeysStatusResponse": { "title": "Update API Keys Status Response", "type": "object", "additionalProperties": false, "description": "This data structure is the response obtained after updating API keys status.", "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "UpdateBulkAlertSchedulerRuleResponse": { "title": "Update bulk alert scheduler rule response data structure", "required": [ "updateSuppressionResponses" ], "type": "object", "properties": { "updateSuppressionResponses": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpdateAlertSchedulerRuleResponse" }, "description": "The update suppression responses." } }, "description": "This is a response sent after updating 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/" } }, "UpdateCaseResponse": { "title": "Update case response", "required": [ "case" ], "type": "object", "properties": { "case": { "allOf": [ { "$ref": "#/components/schemas/Case" } ], "description": "Updated case" } }, "description": "Response containing the updated case" }, "UpdateCaseSettingsResponse": { "title": "Update case settings response", "required": [ "caseSettings" ], "type": "object", "properties": { "caseSettings": { "allOf": [ { "$ref": "#/components/schemas/CaseSettings" } ], "description": "The updated case settings team configuration" } }, "description": "Response containing the updated case settings team configuration." }, "UpdateCommentResponse": { "title": "Update comment event response", "required": [ "event" ], "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" } ], "description": "Updated comment event" } }, "description": "Response returned after successfully updating a comment." }, "UpdateContextualDataIntegrationResponse": { "title": "Update contextual data integration response", "type": "object", "additionalProperties": false, "description": "Response returned after successfully updating a contextual data integration." }, "UpdateCustomEnrichmentResponse": { "title": "Update Custom Enrichment Response", "type": "object", "properties": { "customEnrichment": { "$ref": "#/components/schemas/CustomEnrichment" }, "message": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message.", "examples": [ "Custom enrichment updated successfully" ] } }, "description": "This response data structure is obtained when a custom enrichment is updated", "externalDocs": { "description": "Find out more about enrichments", "url": "https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/" } }, "UpdateCustomEvaluationResponse": { "type": "object", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/CustomEvaluation" } ], "description": "The updated custom evaluation." } }, "description": "Response returned after updating a custom evaluation." }, "UpdateExtensionResponse": { "title": "Update extension response", "type": "object", "properties": { "extensionDeployment": { "$ref": "#/components/schemas/ExtensionDeployment" } }, "description": "Response returned after successfully updating a deployed extension." }, "UpdateIntegrationResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully updating an integration." }, "UpdateOutgoingWebhookResponse": { "title": "Update outgoing webhook response", "type": "object", "additionalProperties": false, "description": "Response returned after successfully updating an outgoing webhook." }, "UpdatePolicyResponse": { "title": "Update Policy Response", "required": [ "policy" ], "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/Policy" } }, "description": "This data structue is obtained when updating a policy.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "UpdateRetentionsResponse": { "title": "Update Retentions Response", "required": [ "retentions" ], "type": "object", "properties": { "retentions": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/archive.v1.Retention" }, "description": "The retentions." } }, "description": "This data structure is obtained after updating retentions", "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "UpdateRoleResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after successfully updating a custom role." }, "UpdateRuleGroupResponse": { "type": "object", "properties": { "ruleGroup": { "$ref": "#/components/schemas/RuleGroup" } }, "description": "Response returned after successfully updating a parsing rule group." }, "UpdateScopeResponse": { "title": "Update Scope Response", "required": [ "scope" ], "type": "object", "properties": { "scope": { "$ref": "#/components/schemas/v1.Scope" } }, "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "UpdateTeamGroupResponse": { "title": "UpdateTeamGroupResponse", "type": "object", "properties": { "group": { "$ref": "#/components/schemas/TeamGroup" } }, "description": "Response containing the updated team group.", "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/" } }, "UpdateTeamResponse": { "type": "object", "additionalProperties": false, "description": "Empty response returned after updating a team." }, "UpdateUserRequest": { "type": "object", "properties": { "userAccountId": { "minimum": 0, "type": "integer", "description": "User account ID of the user to update", "format": "int64" }, "userId": { "description": "Stable id of the user to update, as an alternative to `userAccountId`. Mutually exclusive with `userAccountId`: exactly one must be set.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]+$", "type": "string", "x-coralogix-presence": true }, "userTemplate": { "allOf": [ { "$ref": "#/components/schemas/UserTemplate" } ], "description": "Template containing updated user properties. Only provided fields will be updated." } } }, "UpdateUsersResponse": { "title": "UpdateUsersResponse", "type": "object", "properties": { "userAccountIds": { "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer", "description": "List of user account IDs for the successfully updated users", "format": "int64" }, "description": "List of user account IDs for the successfully updated users" }, "users": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/rbac.v2.User" }, "description": "Full details of the successfully updated users, as returned by GetUser." } }, "description": "Response confirming the successful update of users. Contains the user account IDs of all users that were updated.", "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", "properties": { "userAccountIds": { "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer", "description": "List of user account IDs for users whose status was successfully updated", "format": "int64" }, "description": "List of user account IDs for users whose status was successfully updated" } }, "description": "Response confirming the successful status update of users. Contains the user account IDs of all users whose status was changed.", "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/" } }, "UpsertIncidentStatePayload": { "type": "object", "properties": { "cxEventKey": { "description": "The CX event key.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Upsert incident state payload." }, "UpsertIncidentStateType": { "enum": [ "UPSERT_INCIDENT_STATE_TYPE_UNSPECIFIED", "UPSERT_INCIDENT_STATE_TYPE_TRIGGERED", "UPSERT_INCIDENT_STATE_TYPE_RESOLVED" ], "type": "string", "description": "Upsert incident state type." }, "UrlField": { "required": [ "name", "required" ], "type": "object", "properties": { "name": { "description": "Display name.", "maxLength": 1024, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "required": { "description": "The required.", "type": "boolean", "x-coralogix-presence": true } }, "description": "Declares a URL field that may be required for the Action to be invokable on a log." }, "UsageBucket": { "title": "Usage Bucket", "required": [ "bucketStartMs", "bytes" ], "type": "object", "properties": { "bucketStartMs": { "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "description": "Start of the bucket window, in epoch milliseconds (the rounded-down bucket timestamp).", "examples": [ "1728763200000" ] }, "bytes": { "maxLength": 20, "minLength": 1, "pattern": "^-?[0-9]+$", "type": "string", "description": "Number of bytes the draft policy would match within this bucket.", "examples": [ "552155648" ] } }, "description": "Bytes matched within a single time bucket of the forecast window." }, "UsageCalendarDateRange": { "required": [ "start", "end" ], "type": "object", "properties": { "end": { "allOf": [ { "$ref": "#/components/schemas/Date" } ], "description": "Exclusive end of the range, as a full UTC calendar date later than `start`." }, "start": { "allOf": [ { "$ref": "#/components/schemas/Date" } ], "description": "Inclusive start of the range, as a full UTC calendar date." } }, "description": "Half-open UTC calendar date interval `[start, end)`. Both bounds are required full calendar dates." }, "UsageCapabilityLabel": { "type": "object", "properties": { "highCardinality": { "type": "boolean", "description": "Whether this label is considered high cardinality and therefore more likely to produce large result sets." }, "key": { "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "description": "Canonical label key string.", "examples": [ "feature_id" ] }, "keyDescription": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Short user-facing description of the label." }, "knownValues": { "maxItems": 4096, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageCapabilityLabel.LabelValue" }, "description": "Stable known values for the label when available. May be incomplete for dynamic or evolving labels." } }, "description": "A label supported by the public data-usage query surface." }, "UsageCapabilityLabel.LabelValue": { "type": "object", "properties": { "description": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Short user-facing description of this value." }, "value": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The label value.", "examples": [ "logs_ingestion" ] } }, "description": "A known value for a label, with a short description." }, "UsageCapabilityMeasurement": { "type": "object", "properties": { "description": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Short user-facing description of this measurement kind." }, "kind": { "allOf": [ { "$ref": "#/components/schemas/UsageMeasurementKind" } ], "description": "Server-defined measurement kind." }, "unit": { "allOf": [ { "$ref": "#/components/schemas/UsageMeasurementUnit" } ], "description": "Raw unit returned for this measurement kind." } }, "description": "A measurement kind supported by the public data-usage query surface, with its raw unit." }, "UsageDailyQuery": { "type": "object", "oneOf": [ { "required": [ "dateRange" ], "type": "object" }, { "required": [ "relativeRange" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "dateRange" ], "type": "object" }, { "required": [ "relativeRange" ], "type": "object" } ] } } ], "properties": { "dateRange": { "$ref": "#/components/schemas/UsageCalendarDateRange" }, "relativeRange": { "$ref": "#/components/schemas/UsageDailyRelativeRange" } }, "description": "Day-oriented query. Always returns 1-day UTC buckets." }, "UsageDailyRelativeRange": { "title": "Daily relative range", "enum": [ "DAILY_RELATIVE_RANGE_UNSPECIFIED", "DAILY_RELATIVE_RANGE_CURRENT_MONTH", "DAILY_RELATIVE_RANGE_PREVIOUS_MONTH", "DAILY_RELATIVE_RANGE_CURRENT_YEAR", "DAILY_RELATIVE_RANGE_LAST_7_DAYS", "DAILY_RELATIVE_RANGE_LAST_14_DAYS", "DAILY_RELATIVE_RANGE_LAST_30_DAYS", "DAILY_RELATIVE_RANGE_LAST_90_DAYS", "DAILY_RELATIVE_RANGE_LAST_180_DAYS", "DAILY_RELATIVE_RANGE_LAST_365_DAYS" ], "type": "string", "description": "Relative day-oriented presets resolved by the server at request time." }, "UsageEntry": { "type": "object", "properties": { "labels": { "maxItems": 16, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageLabel" }, "description": "Label values matching the request's `groupBy` keys. Empty when the request does not group by labels." }, "measurements": { "maxItems": 8, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageMeasurement" }, "description": "Raw usage measurements for this label combination." } }, "description": "One row of usage for a unique combination of grouped label values, with its raw measurements." }, "UsageGroupBy": { "type": "object", "properties": { "keys": { "maxItems": 16, "minItems": 0, "type": "array", "items": { "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "description": "Label key to group by. Supported keys are listed by the capabilities endpoint." }, "description": "Label key to group by. Supported keys are listed by the capabilities endpoint.", "examples": [ [ "feature_id" ] ] } }, "description": "Set of canonical label keys to group results by." }, "UsageHourlyQuery": { "type": "object", "oneOf": [ { "required": [ "timeRange" ], "type": "object" }, { "required": [ "relativeRange" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "timeRange" ], "type": "object" }, { "required": [ "relativeRange" ], "type": "object" } ] } } ], "properties": { "relativeRange": { "$ref": "#/components/schemas/UsageHourlyRelativeRange" }, "timeRange": { "$ref": "#/components/schemas/UsageTimestampRange" } }, "description": "Hour-oriented query. Always returns 1-hour buckets. Max window: 14 days." }, "UsageHourlyRelativeRange": { "title": "Hourly relative range", "enum": [ "HOURLY_RELATIVE_RANGE_UNSPECIFIED", "HOURLY_RELATIVE_RANGE_LAST_12_HOURS", "HOURLY_RELATIVE_RANGE_LAST_24_HOURS", "HOURLY_RELATIVE_RANGE_LAST_48_HOURS", "HOURLY_RELATIVE_RANGE_LAST_7_DAYS", "HOURLY_RELATIVE_RANGE_LAST_14_DAYS" ], "type": "string", "description": "Relative hour-oriented presets resolved by the server at request time." }, "UsageLabel": { "type": "object", "properties": { "key": { "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "description": "Canonical response label key string.", "examples": [ "feature_id" ] }, "value": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Value of the label for this row.", "examples": [ "logs_ingestion" ] } }, "description": "A single label key/value pair in the grouped result." }, "UsageLabelFilter": { "required": [ "key", "operator", "values" ], "type": "object", "properties": { "key": { "maxLength": 256, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "description": "Label key to filter on. Supported keys are listed by the capabilities endpoint.", "examples": [ "pillar" ] }, "operator": { "allOf": [ { "$ref": "#/components/schemas/UsageLabelFilter.FilterOperator" } ], "description": "How `values` is matched against the label." }, "values": { "maxItems": 1024, "minItems": 1, "type": "array", "items": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Values to match against `key`. Required and must be non-empty when an `operator` is set." }, "description": "Values to match against `key`. Required and must be non-empty when an `operator` is set.", "examples": [ [ "logs" ] ] } }, "description": "Predicate applied to a single label before aggregation. A complete predicate requires `key`, `operator`, and a non-empty `values` list." }, "UsageLabelFilter.FilterOperator": { "title": "Label filter operator", "enum": [ "FILTER_OPERATOR_UNSPECIFIED", "FILTER_OPERATOR_IN", "FILTER_OPERATOR_NOT_IN" ], "type": "string", "description": "How `values` are matched against the label: inclusively (one of) or exclusively (none of)." }, "UsageLimit": { "type": "object", "properties": { "perBucket": { "maximum": 100000, "minimum": 1, "type": "integer", "description": "Maximum number of usage entries returned per bucket. The server may apply a lower hard limit.", "format": "int64" } }, "description": "Per-bucket result-size cap requested by the client." }, "UsageMeasurement": { "type": "object", "properties": { "cxQuotaUnits": { "type": "object", "properties": { "value": { "maxLength": 128, "minLength": 1, "pattern": "^[+-]?(?:\\d+(?:\\.\\d*)?|\\.\\d+)(?:[eE][+-]?\\d+)?$", "type": "string", "description": "Decimal value encoded as a string, using optional sign, fraction, and exponent notation." } }, "description": "Billable units charged for this measurement. The decimal magnitude is carried as a string in the `value` field of this object.", "examples": [ { "value": "1.5" } ] }, "kind": { "allOf": [ { "$ref": "#/components/schemas/UsageMeasurementKind" } ], "description": "Server-defined measurement kind for this row." }, "measuredUnit": { "allOf": [ { "$ref": "#/components/schemas/UsageMeasurementUnit" } ], "description": "Unit of the raw measured amount." }, "measuredValue": { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "description": "Raw measured amount for this usage row, in the unit indicated by `measuredUnit`." } }, "description": "Raw measurement of a single kind for the parent usage row." }, "UsageMeasurementKind": { "title": "Measurement kind", "enum": [ "MEASUREMENT_KIND_UNSPECIFIED", "MEASUREMENT_KIND_PROCESSED_DATA_SIZE", "MEASUREMENT_KIND_EVALUATIONS", "MEASUREMENT_KIND_PROCESSED_EVENTS", "MEASUREMENT_KIND_OLLY" ], "type": "string", "description": "Type of usage this entry reports." }, "UsageMeasurementUnit": { "title": "Measurement unit", "enum": [ "MEASUREMENT_UNIT_UNSPECIFIED", "MEASUREMENT_UNIT_BYTES", "MEASUREMENT_UNIT_TOKENS", "MEASUREMENT_UNIT_EVENTS" ], "type": "string", "description": "Raw unit of a measured amount." }, "UsageTier": { "type": "object", "properties": { "dailyQuotaPercentage": { "maximum": 100, "minimum": 0, "type": "number", "description": "The daily quota percentage. Must be between 0 and 100.", "format": "double", "examples": [ 80 ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/quota.v1.Priority" } ], "examples": [ "PRIORITY_TYPE_HIGH" ] } } }, "UsageTimestampRange": { "required": [ "start", "end" ], "type": "object", "properties": { "end": { "description": "Exclusive end of the timestamp range, as a UTC timestamp string later than `start`.", "examples": [ "2026-06-08T00:00:00.000Z" ], "format": "date-time", "maxLength": 32, "minLength": 0, "type": "string", "x-coralogix-presence": true }, "start": { "description": "Inclusive start of the timestamp range, as a UTC timestamp string.", "examples": [ "2026-06-01T00:00:00.000Z" ], "format": "date-time", "maxLength": 32, "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Half-open timestamp interval `[start, end)`. Both bounds are required." }, "UserActor": { "title": "User actor", "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": "User ID", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ] } }, "description": "Information about the user who initiated the action." }, "UserIdList": { "type": "object", "properties": { "userIds": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The user ids." }, "description": "The user ids." } }, "description": "User id list." }, "UserStatus": { "enum": [ "USER_STATUS_UNSPECIFIED", "USER_STATUS_ACTIVE", "USER_STATUS_INACTIVE" ], "type": "string", "description": "User status." }, "UserTemplate": { "title": "UserTemplate", "type": "object", "properties": { "accessType": { "allOf": [ { "$ref": "#/components/schemas/AccessType" } ], "description": "Access type configuration - defines whether user access is permanent or temporary with expiration" }, "allowedLoginMode": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AllowedLoginMode" }, "description": "List of allowed login modes. Can include SSO, local authentication, or both. Not supported in invite onboarding mode" }, "firstName": { "minLength": 0, "type": "string", "description": "User's first name" }, "lastName": { "minLength": 0, "type": "string", "description": "User's last name" }, "status": { "allOf": [ { "$ref": "#/components/schemas/UserStatus" } ], "description": "User status: Active (user can access the system) or Inactive (user access is disabled)" }, "username": { "minLength": 0, "type": "string", "description": "Unique username for the user. Must be unique within the system. Updating username for existing users is not supported and ignored." } }, "description": "Template containing all user properties that can be set when creating or updating a user. Includes personal information, status, authentication methods, and access duration.", "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/" } }, "UserUpdates": { "title": "UserUpdates", "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/UserUpdatesOperation" } }, "description": "Patch object for updating group user membership. Choose one operation: add, remove, or replace all users.", "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/" } }, "UserUpdatesOperation": { "required": [ "operationType" ], "type": "object", "oneOf": [ { "required": [ "add" ], "type": "object" }, { "required": [ "remove" ], "type": "object" }, { "required": [ "set" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "add" ], "type": "object" }, { "required": [ "remove" ], "type": "object" }, { "required": [ "set" ], "type": "object" } ] } } ], "properties": { "add": { "$ref": "#/components/schemas/UserIdList" }, "operationType": { "minLength": 0, "type": "string", "description": "Discriminator indicating the user update operation type (add, remove, or set)." }, "remove": { "$ref": "#/components/schemas/UserIdList" }, "set": { "$ref": "#/components/schemas/UserIdList" } }, "description": "User id list.", "discriminator": { "propertyName": "operationType" } }, "ValidateEntityLabelMatcherResponse": { "title": "Validate Entity Label Matcher Response", "type": "object", "properties": { "result": { "$ref": "#/components/schemas/ValidateEntityLabelMatcherResult" } }, "description": "Response which contains whether the given entity label matcher is valid", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "ValidateEntityLabelMatcherResult": { "type": "object", "oneOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "success" ], "type": "object" }, { "required": [ "failure" ], "type": "object" } ] } } ], "properties": { "failure": { "$ref": "#/components/schemas/ValidateEntityLabelMatcherResult.Failure" }, "success": { "$ref": "#/components/schemas/ValidateEntityLabelMatcherResult.Success" } }, "description": "Result of validating an entity label matcher, indicating whether it is valid or contains errors." }, "ValidateEntityLabelMatcherResult.Failure": { "type": "object", "properties": { "message": { "maxLength": 10000, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Human-readable message." } }, "description": "Test outgoing webhook response.failure." }, "ValidateEntityLabelMatcherResult.Success": { "type": "object", "additionalProperties": false, "description": "Test integration result.success." }, "Value": { "enum": [ "VALUE_DEBUG_OR_UNSPECIFIED", "VALUE_VERBOSE", "VALUE_INFO", "VALUE_WARNING", "VALUE_ERROR", "VALUE_CRITICAL" ], "type": "string", "description": "Log severity. The zero value `VALUE_DEBUG_OR_UNSPECIFIED` means debug." }, "ValueCount": { "title": "Filter value count", "type": "object", "properties": { "count": { "maximum": 1000000000, "minimum": 0, "type": "integer", "description": "Count of cases for this value", "format": "int64", "examples": [ 8 ] }, "value": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Filter value", "examples": [ "service:payments" ] } }, "description": "Number of cases that share a single filter group value." }, "ValueLabel": { "required": [ "value", "label" ], "type": "object", "properties": { "isDefault": { "description": "The is default.", "type": "boolean", "x-coralogix-presence": true }, "label": { "description": "The label.", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "A value/label pair for a static source. Both value and label must be set; clients typically default the label to the value." }, "ValuesMappingType": { "enum": [ "VALUES_MAPPING_TYPE_UNSPECIFIED", "VALUES_MAPPING_TYPE_VALUE", "VALUES_MAPPING_TYPE_REGEX" ], "type": "string", "description": "Values mapping type." }, "Variable": { "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/Variable.Definition" }, "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "displayName": { "description": "The display name.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "displayType": { "$ref": "#/components/schemas/VariableDisplayType" }, "name": { "description": "Display name.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } } }, "Variable.Definition": { "type": "object", "oneOf": [ { "required": [ "constant" ], "type": "object" }, { "required": [ "multiSelect" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "constant" ], "type": "object" }, { "required": [ "multiSelect" ], "type": "object" } ] } } ], "properties": { "constant": { "allOf": [ { "$ref": "#/components/schemas/Constant" } ], "deprecated": true }, "multiSelect": { "$ref": "#/components/schemas/MultiSelect" } }, "description": "Discriminated union defining the variable type: either a constant value or a multi-select query-driven variable." }, "VariableDisplayType": { "enum": [ "VARIABLE_DISPLAY_TYPE_UNSPECIFIED", "VARIABLE_DISPLAY_TYPE_LABEL_VALUE", "VARIABLE_DISPLAY_TYPE_VALUE", "VARIABLE_DISPLAY_TYPE_NOTHING" ], "type": "string", "description": "Variable display type." }, "VariableDisplayTypeV2": { "enum": [ "VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED", "VARIABLE_DISPLAY_TYPE_V2_LABEL_VALUE", "VARIABLE_DISPLAY_TYPE_V2_VALUE", "VARIABLE_DISPLAY_TYPE_V2_NOTHING" ], "type": "string", "description": "Variable display type v2. A concrete value is required — VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED is rejected by the API." }, "VariableSelectionOptions": { "type": "object", "properties": { "selectionType": { "$ref": "#/components/schemas/SelectionType" } }, "description": "Variable selection options." }, "VariableSourceV2": { "type": "object", "oneOf": [ { "required": [ "static" ], "type": "object" }, { "required": [ "query" ], "type": "object" }, { "required": [ "textbox" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "static" ], "type": "object" }, { "required": [ "query" ], "type": "object" }, { "required": [ "textbox" ], "type": "object" } ] } } ], "properties": { "query": { "$ref": "#/components/schemas/VariableSourceV2.QuerySource" }, "static": { "$ref": "#/components/schemas/StaticSource" }, "textbox": { "$ref": "#/components/schemas/TextboxSource" } }, "description": "Variable source v2." }, "VariableSourceV2.QuerySource": { "required": [ "valuesOrderDirection", "allOption" ], "type": "object", "oneOf": [ { "required": [ "logsQuery" ], "type": "object" }, { "required": [ "metricsQuery" ], "type": "object" }, { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "dataprimeQuery" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "logsQuery" ], "type": "object" }, { "required": [ "metricsQuery" ], "type": "object" }, { "required": [ "spansQuery" ], "type": "object" }, { "required": [ "dataprimeQuery" ], "type": "object" } ] } } ], "properties": { "allOption": { "$ref": "#/components/schemas/AllOption" }, "dataprimeQuery": { "$ref": "#/components/schemas/QuerySource.DataprimeQuery" }, "logsQuery": { "$ref": "#/components/schemas/QuerySource.LogsQuery" }, "metricsQuery": { "$ref": "#/components/schemas/QuerySource.MetricsQuery" }, "refreshStrategy": { "$ref": "#/components/schemas/VariableSourceV2.RefreshStrategy" }, "spansQuery": { "$ref": "#/components/schemas/QuerySource.SpansQuery" }, "valueDisplayOptions": { "$ref": "#/components/schemas/VariableSourceV2.ValueDisplayOptions" }, "valuesOrderDirection": { "allOf": [ { "$ref": "#/components/schemas/OrderDirection" } ], "description": "Values sort order. A concrete value is required — ORDER_DIRECTION_UNSPECIFIED is rejected." } }, "description": "Variable source backed by a query against logs, metrics, spans, or Dataprime data. Exactly one of logsQuery, metricsQuery, spansQuery, or dataprimeQuery must be set — the service rejects an object with no query arm (this exactly-one rule is enforced by the API, not by the OpenAPI oneOf schema). valuesOrderDirection is required and must be a concrete value — ORDER_DIRECTION_UNSPECIFIED is rejected. PromQL (metricsQuery.type.promqlQuery) and Dataprime (dataprimeQuery.type.queryText) query text is syntax-checked only by POST /dashboards/check/v1 — create and replace accept it without compiling." }, "VariableSourceV2.RefreshStrategy": { "enum": [ "REFRESH_STRATEGY_UNSPECIFIED", "REFRESH_STRATEGY_ON_DASHBOARD_LOAD", "REFRESH_STRATEGY_ON_TIME_FRAME_CHANGE" ], "type": "string", "description": "Refresh strategy." }, "VariableSourceV2.ValueDisplayOptions": { "type": "object", "properties": { "labelRegex": { "description": "The label regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "valueRegex": { "description": "The value regex.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Value display options." }, "VariableV2": { "required": [ "id", "name", "displayName", "displayType", "source", "value" ], "type": "object", "properties": { "description": { "description": "Human-readable description.", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "displayFullRow": { "description": "The display full row.", "type": "boolean", "x-coralogix-presence": true }, "displayName": { "description": "The display name.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "displayType": { "allOf": [ { "$ref": "#/components/schemas/VariableDisplayTypeV2" } ], "description": "How the variable is rendered in the dashboard header. A concrete value is required — VARIABLE_DISPLAY_TYPE_V2_UNSPECIFIED is rejected." }, "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Variable's unique identifier" }, "name": { "description": "Variable name, used to reference the variable in widget queries. Should match ^[a-zA-Z0-9_]+$ and be unique within the dashboard.", "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "source": { "$ref": "#/components/schemas/VariableSourceV2" }, "value": { "$ref": "#/components/schemas/VariableValueV2" } }, "description": "Dashboard variable (v2). displayFullRow may be true only when source is a textbox; it is rejected for static and query sources." }, "VariableValueV2": { "type": "object", "oneOf": [ { "required": [ "multiString" ], "type": "object" }, { "required": [ "singleString" ], "type": "object" }, { "required": [ "singleNumeric" ], "type": "object" }, { "required": [ "regex" ], "type": "object" }, { "required": [ "lucene" ], "type": "object" }, { "required": [ "interval" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "multiString" ], "type": "object" }, { "required": [ "singleString" ], "type": "object" }, { "required": [ "singleNumeric" ], "type": "object" }, { "required": [ "regex" ], "type": "object" }, { "required": [ "lucene" ], "type": "object" }, { "required": [ "interval" ], "type": "object" } ] } } ], "properties": { "interval": { "$ref": "#/components/schemas/IntervalValue" }, "lucene": { "allOf": [ { "$ref": "#/components/schemas/LuceneQueryValue" } ], "description": "The lucene." }, "multiString": { "$ref": "#/components/schemas/MultiStringValue" }, "regex": { "$ref": "#/components/schemas/RegexValue" }, "singleNumeric": { "$ref": "#/components/schemas/VariableValueV2.SingleNumericValue" }, "singleString": { "$ref": "#/components/schemas/SingleStringValue" } }, "description": "Discriminated union representing the current runtime value of a dashboard variable (string, numeric, regex, Lucene, or interval)." }, "VariableValueV2.SingleNumericValue": { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/NumericValueLabel" } ], "description": "The value." } }, "description": "Integration revision.single numeric value." }, "Variant": { "enum": [ "DEFAULT", "GCP", "OAUTH", "CUSTOM" ], "type": "string", "description": "Variant." }, "VerticalBars": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "barValueDisplay": { "allOf": [ { "$ref": "#/components/schemas/Visualization.BarValueDisplay" } ], "description": "Specifies where to display the bar value" }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "maxSlicesPerBar": { "description": "How many slices can fit in a single bar", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortBy": { "allOf": [ { "$ref": "#/components/schemas/SortByType" } ], "description": "Sort type, by name or by value", "examples": [ "1" ] }, "stackNameTemplate": { "description": "Custom template name of an individual stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "subCategoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The sub category fields." }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "valueField": { "$ref": "#/components/schemas/ObservationField" }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Vertical bars." }, "VerticalBarsMulti": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "barValueDisplay": { "allOf": [ { "$ref": "#/components/schemas/Visualization.BarValueDisplay" } ], "description": "Specifies where to display the bar value" }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "colorsBy": { "allOf": [ { "$ref": "#/components/schemas/ColorsBy" } ], "description": "How the bar colors should be organized" }, "customUnit": { "description": "Custom unit (requires to have unit field set to custom to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 4 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxBarsPerChart": { "description": "Maximum number of bars on a chart", "examples": [ 20 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "queryFieldSettings": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/VerticalBarsMulti.QueryFieldSettings" }, "description": "Per-query field settings" }, "scaleType": { "allOf": [ { "$ref": "#/components/schemas/ScaleType" } ], "description": "Scale type - linear/logarithmic" }, "sortOrder": { "allOf": [ { "$ref": "#/components/schemas/Visualization.SortOrder" } ], "description": "Sort order for bars - by category or by a specific observation field" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the query results - one from a predefined list, or custom", "examples": [ "3" ] }, "yAxisMax": { "description": "Number indicating the upper band for y axis", "examples": [ 1000 ], "format": "float", "type": "number", "x-coralogix-presence": true }, "yAxisMin": { "description": "Number indicating the lower band for y axis", "examples": [ -1000 ], "format": "float", "type": "number", "x-coralogix-presence": true } }, "description": "Visualization configuration for vertical bars with multiple queries." }, "VerticalBarsMulti.QueryFieldSettings": { "title": "VerticalBarsMultiQueryFieldSettings", "required": [ "queryId" ], "type": "object", "properties": { "queryId": { "description": "Reference to the query id from Dynamic.query_display_settings", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "description": "Numeric field for this query - each bar gets one value column" } }, "description": "Per-query field settings for vertical bars multi-query visualization" }, "View": { "title": "View", "required": [ "name", "id", "timeSelection" ], "type": "object", "properties": { "filters": { "$ref": "#/components/schemas/SelectedFilters" }, "folderId": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "id": { "description": "id", "examples": [ 52 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "isCompactMode": { "default": false, "description": "Whether the view opens in compact mode. Create stores false, and a replace that omits the value stores false.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "View name", "examples": [ "Logs view" ], "maxLength": 250, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "searchQuery": { "$ref": "#/components/schemas/SearchQuery" }, "timeSelection": { "$ref": "#/components/schemas/TimeSelection" }, "viewType": { "$ref": "#/components/schemas/ViewType" } }, "description": "Response for views." }, "ViewFolder": { "title": "ViewFolder", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "description": "Unique identifier for folders", "examples": [ "3dc02998-0b50-4ea8-b68a-4779d716fa1f" ], "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", "x-coralogix-presence": true }, "name": { "description": "Folder name", "examples": [ "My Folder" ], "maxLength": 100, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "View folder." }, "ViewType": { "enum": [ "VIEW_TYPE_UNSPECIFIED", "VIEW_TYPE_LOGS", "VIEW_TYPE_TEMPLATES", "VIEW_TYPE_ARCHIVE_LOGS", "VIEW_TYPE_ARCHIVE_TEMPLATES" ], "type": "string", "description": "View type." }, "Visualization": { "type": "object", "oneOf": [ { "required": [ "table" ], "type": "object" }, { "required": [ "timeSeriesLines" ], "type": "object" }, { "required": [ "timeSeriesBars" ], "type": "object" }, { "required": [ "stat" ], "type": "object" }, { "required": [ "gauge" ], "type": "object" }, { "required": [ "hexagonBins" ], "type": "object" }, { "required": [ "pieChart" ], "type": "object" }, { "required": [ "horizontalBars" ], "type": "object" }, { "required": [ "verticalBars" ], "type": "object" }, { "required": [ "heatmap" ], "type": "object" }, { "required": [ "geomap" ], "type": "object" }, { "required": [ "timeSeriesLinesMulti" ], "type": "object" }, { "required": [ "verticalBarsMulti" ], "type": "object" }, { "required": [ "horizontalBarsMulti" ], "type": "object" }, { "required": [ "statCard" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "table" ], "type": "object" }, { "required": [ "timeSeriesLines" ], "type": "object" }, { "required": [ "timeSeriesBars" ], "type": "object" }, { "required": [ "stat" ], "type": "object" }, { "required": [ "gauge" ], "type": "object" }, { "required": [ "hexagonBins" ], "type": "object" }, { "required": [ "pieChart" ], "type": "object" }, { "required": [ "horizontalBars" ], "type": "object" }, { "required": [ "verticalBars" ], "type": "object" }, { "required": [ "heatmap" ], "type": "object" }, { "required": [ "geomap" ], "type": "object" }, { "required": [ "timeSeriesLinesMulti" ], "type": "object" }, { "required": [ "verticalBarsMulti" ], "type": "object" }, { "required": [ "horizontalBarsMulti" ], "type": "object" }, { "required": [ "statCard" ], "type": "object" } ] } } ], "properties": { "gauge": { "$ref": "#/components/schemas/Visualization.Gauge" }, "geomap": { "$ref": "#/components/schemas/Geomap" }, "heatmap": { "$ref": "#/components/schemas/Heatmap" }, "hexagonBins": { "$ref": "#/components/schemas/HexagonBins" }, "horizontalBars": { "$ref": "#/components/schemas/HorizontalBars" }, "horizontalBarsMulti": { "$ref": "#/components/schemas/HorizontalBarsMulti" }, "pieChart": { "$ref": "#/components/schemas/Visualization.PieChart" }, "stat": { "$ref": "#/components/schemas/Stat" }, "statCard": { "$ref": "#/components/schemas/StatCard" }, "table": { "$ref": "#/components/schemas/Table" }, "timeSeriesBars": { "$ref": "#/components/schemas/TimeSeriesBars" }, "timeSeriesLines": { "allOf": [ { "$ref": "#/components/schemas/TimeSeriesLines" } ], "deprecated": true }, "timeSeriesLinesMulti": { "$ref": "#/components/schemas/TimeSeriesLinesMulti" }, "verticalBars": { "$ref": "#/components/schemas/VerticalBars" }, "verticalBarsMulti": { "$ref": "#/components/schemas/VerticalBarsMulti" } }, "description": "Visualization." }, "Visualization.BarValueDisplay": { "enum": [ "BAR_VALUE_DISPLAY_UNSPECIFIED", "BAR_VALUE_DISPLAY_TOP", "BAR_VALUE_DISPLAY_INSIDE", "BAR_VALUE_DISPLAY_BOTH" ], "type": "string", "description": "Bar value display." }, "Visualization.Gauge": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "arcDisplay": { "allOf": [ { "$ref": "#/components/schemas/ArcDisplay" } ], "description": "Arc display settings; set this object to show the gauge arcs and control the value and threshold arcs, or omit it to hide all arcs" }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "List of observation fields used to split gauge into multiple gauge instances." }, "customUnit": { "description": "Custom unit (requires to have unit field set as UNIT_CUSTOM to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 2 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "displaySeriesName": { "description": "(multigauge display only) Whether to show the series names above the value", "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "Indicates how to group the legend elements, either by thresholds or by query groups" }, "max": { "description": "A maximum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 150000 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 0 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "showInnerArc": { "deprecated": true, "description": "Deprecated: use arcDisplay.valueArc instead. Whether to show the inner arc of gauge which graphically represents the value", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "showMinMax": { "description": "Whether to display the min and max range values on the gauge", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "showOuterArc": { "deprecated": true, "description": "Deprecated: use arcDisplay.thresholdArc instead. Whether to show the outer arc of gauge which graphically represents the min/max range", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/common.Threshold" }, "description": "List of value thresholds, each with a certain color and an optional name label" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or 'custom'", "examples": [ "3" ] }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ObservationField" } ], "deprecated": true }, "valueFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The value fields." } }, "description": "Gauge." }, "Visualization.PieChart": { "type": "object", "properties": { "allowAbbreviation": { "description": "Whether to render numeric value with abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "categoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The category fields." }, "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires the unit field to be set to custom to take effect)", "maxLength": 128, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 5 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "labelDefinition": { "allOf": [ { "$ref": "#/components/schemas/Visualization.PieChart.LabelDefinition" } ], "description": "Settings for slice labels" }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxSlicesPerChart": { "description": "Maximum number of slices on a chart", "examples": [ 24 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "maxSlicesPerStack": { "description": "How many slices can fit in a single slice stack", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "minSlicePercentage": { "description": "Minimum percentage threshold for slices to be displayed", "examples": [ 5 ], "format": "int32", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "showTotal": { "description": "Whether to show the total amount as a title", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "stackNameTemplate": { "description": "Custom template name of an individual slice in the stack", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "subCategoryFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ObservationField" }, "description": "The sub category fields." }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or custom", "examples": [ "0" ] }, "valueField": { "$ref": "#/components/schemas/ObservationField" } }, "description": "Pie chart." }, "Visualization.PieChart.LabelDefinition": { "type": "object", "properties": { "isVisible": { "description": "Are labels visible", "type": "boolean", "x-coralogix-presence": true }, "labelSource": { "allOf": [ { "$ref": "#/components/schemas/Visualization.PieChart.LabelSource" } ], "description": "Source of the label" }, "showName": { "description": "Whether to show the name of slice in the label", "type": "boolean", "x-coralogix-presence": true }, "showPercentage": { "description": "Whether to show percentage value of slice in the label", "type": "boolean", "x-coralogix-presence": true }, "showValue": { "description": "Whether to show value of slice in the label", "type": "boolean", "x-coralogix-presence": true } }, "description": "Label definition." }, "Visualization.PieChart.LabelSource": { "enum": [ "LABEL_SOURCE_UNSPECIFIED", "LABEL_SOURCE_INNER", "LABEL_SOURCE_STACK" ], "type": "string", "description": "Label source." }, "Visualization.SortOrder": { "title": "SortOrder", "type": "object", "properties": { "orderDirection": { "allOf": [ { "$ref": "#/components/schemas/OrderDirection" } ], "description": "Order direction, ascending or descending", "examples": [ "1" ] }, "strategy": { "allOf": [ { "$ref": "#/components/schemas/SortStrategy" } ], "description": "How to determine sort key - by category or by query value" } }, "description": "Sort order with direction and strategy - either by category or by query value" }, "Visualization.StackedLine": { "enum": [ "STACKED_LINE_UNSPECIFIED", "STACKED_LINE_ABSOLUTE", "STACKED_LINE_RELATIVE" ], "type": "string", "description": "Stacked line." }, "WebhookType": { "enum": [ "UNKNOWN", "GENERIC", "SLACK", "PAGERDUTY", "SEND_LOG", "EMAIL_GROUP", "MICROSOFT_TEAMS", "JIRA", "OPSGENIE", "DEMISTO", "AWS_EVENT_BRIDGE", "IBM_EVENT_NOTIFICATIONS", "MS_TEAMS_WORKFLOW" ], "type": "string", "description": "Webhook type." }, "Week": { "title": "Week", "type": "object", "additionalProperties": false, "description": "Marker selecting a one-week forecast window." }, "Weekday": { "enum": [ "WEEKDAY_UNSPECIFIED", "WEEKDAY_MONDAY", "WEEKDAY_TUESDAY", "WEEKDAY_WEDNESDAY", "WEEKDAY_THURSDAY", "WEEKDAY_FRIDAY", "WEEKDAY_SATURDAY", "WEEKDAY_SUNDAY" ], "type": "string" }, "Weekly": { "required": [ "daysOfWeek" ], "type": "object", "properties": { "daysOfWeek": { "description": "The days of week.", "items": { "type": "integer", "description": "The days of week.", "format": "int32" }, "minItems": 1, "type": "array", "x-coralogix-collection": "set" } }, "description": "Weekly." }, "WeeklyRecurrence": { "type": "object", "properties": { "daysOfWeek": { "maxItems": 7, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Weekday" }, "description": "The days of week." } }, "description": "Weekly recurrence." }, "WhoAmIResponse": { "title": "WhoAmIResponse", "required": [ "teamId", "teamName" ], "type": "object", "properties": { "teamId": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Identifier of the team the credentials belong to.", "format": "int64", "examples": [ 1234567 ] }, "teamName": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Display name of the team.", "examples": [ "my-team" ] }, "teamUrl": { "description": "Full web-app URL of the team. Absent when the team has no URL slug configured.", "examples": [ "https://my-team.app.coralogix.com" ], "maxLength": 2048, "minLength": 1, "pattern": "^https://[^\\s/?#]+[^\\s]*$", "type": "string", "x-coralogix-presence": true }, "username": { "description": "Username of the authenticated user. Absent when authenticating with an API key, which carries no user identity.", "examples": [ "jane.doe@example.com" ], "maxLength": 320, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "The team, and where available the user, that the presented credentials authenticate as." }, "Widget": { "title": "Widget", "type": "object", "properties": { "appearance": { "allOf": [ { "$ref": "#/components/schemas/Widget.Appearance" } ], "deprecated": true }, "createdAt": { "description": "Creation timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true }, "definition": { "allOf": [ { "$ref": "#/components/schemas/Widget.Definition" } ], "description": "Definition of the widget type and details" }, "description": { "description": "Short description of the widget", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "highlighted": { "type": "boolean", "description": "Deprecated: has no effect. The value is stored and returned unchanged; it does not highlight anything.", "deprecated": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Widget unique identifier" }, "layoutColumns": { "description": "Number of columns occupied by the widget in the dashboard layout", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "reference": { "allOf": [ { "$ref": "#/components/schemas/WidgetReference" } ], "description": "Reference to a widget from another dashboard" }, "title": { "description": "Name of the widget", "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "updatedAt": { "description": "Last-updated timestamp.", "format": "date-time", "maxLength": 30, "minLength": 20, "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about creating dashboard widgets in our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/#add-new-widgets" } }, "Widget.Appearance": { "type": "object", "properties": { "width": { "description": "The width.", "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Appearance." }, "Widget.Definition": { "type": "object", "oneOf": [ { "required": [ "lineChart" ], "type": "object" }, { "required": [ "dataTable" ], "type": "object" }, { "required": [ "gauge" ], "type": "object" }, { "required": [ "pieChart" ], "type": "object" }, { "required": [ "barChart" ], "type": "object" }, { "required": [ "horizontalBarChart" ], "type": "object" }, { "required": [ "markdown" ], "type": "object" }, { "required": [ "hexagon" ], "type": "object" }, { "required": [ "dynamic" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "lineChart" ], "type": "object" }, { "required": [ "dataTable" ], "type": "object" }, { "required": [ "gauge" ], "type": "object" }, { "required": [ "pieChart" ], "type": "object" }, { "required": [ "barChart" ], "type": "object" }, { "required": [ "horizontalBarChart" ], "type": "object" }, { "required": [ "markdown" ], "type": "object" }, { "required": [ "hexagon" ], "type": "object" }, { "required": [ "dynamic" ], "type": "object" } ] } } ], "properties": { "barChart": { "allOf": [ { "$ref": "#/components/schemas/BarChart" } ], "description": "Vertical bar chart widget definition" }, "dataTable": { "allOf": [ { "$ref": "#/components/schemas/DataTable" } ], "description": "Data table widget definition" }, "dynamic": { "allOf": [ { "$ref": "#/components/schemas/widgets.Dynamic" } ], "description": "Dynamic widget definition" }, "gauge": { "allOf": [ { "$ref": "#/components/schemas/widgets.Gauge" } ], "description": "Gauge widget definition" }, "hexagon": { "allOf": [ { "$ref": "#/components/schemas/Hexagon" } ], "description": "Hexagon widget definition" }, "horizontalBarChart": { "allOf": [ { "$ref": "#/components/schemas/HorizontalBarChart" } ], "description": "Horizontal bar chart widget definition" }, "lineChart": { "allOf": [ { "$ref": "#/components/schemas/LineChart" } ], "description": "Line chart widget definition" }, "markdown": { "allOf": [ { "$ref": "#/components/schemas/Markdown" } ], "description": "Markdown widget definition" }, "pieChart": { "allOf": [ { "$ref": "#/components/schemas/widgets.PieChart" } ], "description": "Pie chart widget definition" } }, "description": "Definition." }, "WidgetReference": { "title": "WidgetReference", "type": "object", "properties": { "dashboardId": { "description": "Dashboard ID containing the referenced widget (21-char NanoIds)", "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "widgetId": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Widget ID within the referenced dashboard" } }, "description": "Reference to a widget from another dashboard" }, "WindowBasedMetricSli": { "title": "WindowBasedMetricSli", "required": [ "query", "window", "comparisonOperator" ], "type": "object", "properties": { "comparisonOperator": { "$ref": "#/components/schemas/ComparisonOperator" }, "missingDataStrategy": { "$ref": "#/components/schemas/MissingDataStrategy" }, "query": { "$ref": "#/components/schemas/Metric" }, "threshold": { "type": "number", "description": "Threshold value.", "format": "float", "examples": [ 0.95 ] }, "window": { "$ref": "#/components/schemas/WindowSloWindow" } }, "description": "Definition of a window-based SLI based on metrics" }, "WindowSloWindow": { "enum": [ "WINDOW_SLO_WINDOW_UNSPECIFIED", "WINDOW_SLO_WINDOW_1_MINUTE", "WINDOW_SLO_WINDOW_5_MINUTES" ], "type": "string", "description": "Window slo window." }, "XAxis": { "type": "object", "oneOf": [ { "required": [ "value" ], "type": "object" }, { "required": [ "time" ], "type": "object" }, { "required": [ "timeBuckets" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "value" ], "type": "object" }, { "required": [ "time" ], "type": "object" }, { "required": [ "timeBuckets" ], "type": "object" } ] } } ], "properties": { "time": { "allOf": [ { "$ref": "#/components/schemas/XAxisByTime" } ], "description": "X axis scale divided into time buckets (deprecated, use time_buckets instead)", "deprecated": true }, "timeBuckets": { "allOf": [ { "$ref": "#/components/schemas/IntervalResolution" } ], "description": "X axis interval resolution settings for time bucket calculations, supporting auto or manual modes" }, "value": { "allOf": [ { "$ref": "#/components/schemas/XAxisByValue" } ], "description": "X axis scale showing individual group values" } }, "description": "X axis." }, "XAxisByTime": { "title": "XAxisByTime", "type": "object", "properties": { "bucketsPresented": { "description": "How many buckets to present in the selected timeframe (deprecated)", "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "interval": { "description": "Interval of value sampling, i.e. every 5 minutes, every 1 second and so on (deprecated)", "maxLength": 30, "minLength": 2, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "X axis by time configuration. (deprecated, use time_buckets instead)" }, "XAxisByValue": { "type": "object", "additionalProperties": false, "description": "X axis by value." }, "XAxisTimeFormat": { "enum": [ "X_AXIS_TIME_FORMAT_UNSPECIFIED", "X_AXIS_TIME_FORMAT_AUTO", "X_AXIS_TIME_FORMAT_DD_MM", "X_AXIS_TIME_FORMAT_MM_DD", "X_AXIS_TIME_FORMAT_HH_MM", "X_AXIS_TIME_FORMAT_DD_MM_HH_MM", "X_AXIS_TIME_FORMAT_HH_MM_DD_MM", "X_AXIS_TIME_FORMAT_MM_DD_HH_MM", "X_AXIS_TIME_FORMAT_HH_MM_MM_DD" ], "type": "string", "description": "X axis time format." }, "YAxisViewByCategory": { "type": "object", "additionalProperties": false, "description": "Y axis view by category." }, "YAxisViewByValue": { "type": "object", "additionalProperties": false, "description": "Y axis view by value." }, "alert_scheduler_rule_protobuf.v1.Filter": { "required": [ "whatExpression" ], "type": "object", "oneOf": [ { "required": [ "alertMetaLabels" ], "type": "object" }, { "required": [ "alertUniqueIds" ], "type": "object" } ], "properties": { "alertMetaLabels": { "$ref": "#/components/schemas/MetaLabels" }, "alertUniqueIds": { "$ref": "#/components/schemas/AlertUniqueIds" }, "whatExpression": { "minLength": 1, "type": "string", "description": "Dataprime expression that filters the alerts by group-by values." } }, "description": "Alert scheduler rule protobuf.v1.filter." }, "alerts.v3.FilterMatcher": { "enum": [ "FILTER_MATCHER_UNSPECIFIED", "FILTER_MATCHER_EQUALS", "FILTER_MATCHER_NOT_EQUALS", "FILTER_MATCHER_CONTAINS" ], "type": "string" }, "alerts.v3.PaginationResponse": { "type": "object", "properties": { "nextPageToken": { "description": "Token for fetching the next page of results.", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "totalSize": { "description": "Total number of results.", "format": "int64", "maximum": 4294967295, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Pagination response." }, "archive.v1.Retention": { "title": "Retention", "required": [ "id", "order", "name", "editable" ], "type": "object", "properties": { "editable": { "description": "Whether an update can change the name. Only the first retention, `Default`, is not editable. In the update response, it is false for a retention named `Default` and true otherwise.", "readOnly": true, "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier. The service sets it.", "minLength": 1, "readOnly": true, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name. The first retention is named `Default`.", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "x-coralogix-presence": true }, "order": { "description": "Sort order, starting at 1. The service sets it, and an update cannot change it.", "format": "int32", "readOnly": true, "type": "integer", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "cases.v1.GetFilterValuesResponse": { "title": "Get case filter values response", "required": [ "priorityAggregations", "categoryAggregations", "groupingAggregations", "labelAggregations", "statusAggregations", "flatLabelsAggregation", "alertIdAggregations" ], "type": "object", "properties": { "alertIdAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AlertIdAggregation" }, "description": "Aggregated case counts per alert definition ID. Only populated when alert_filters is provided in the request." }, "assigneeAggregations": { "allOf": [ { "$ref": "#/components/schemas/AssigneeAggregation" } ], "description": "Aggregated case counts grouped by assignee." }, "categoryAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CategoryAggregation" }, "description": "Aggregated case counts grouped by category." }, "flatLabelsAggregation": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterAggregation" }, "description": "Aggregated case counts grouped by individual flat label key/value pairs." }, "groupingAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterGroupAggregation" }, "description": "Aggregated case counts grouped by grouping key/value pairs." }, "labelAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/FilterGroupAggregation" }, "description": "Aggregated case counts grouped by label key/value pairs." }, "priorityAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PriorityAggregation" }, "description": "Aggregated case counts grouped by priority." }, "statusAggregations": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/StatusAggregation" }, "description": "Aggregated case counts grouped by status." } }, "description": "Aggregated counts for building filters in the UI" }, "cases.v1.PaginationRequest": { "title": "Pagination request", "type": "object", "properties": { "pageSize": { "description": "Number of items to return per page", "examples": [ 10 ], "format": "int64", "maximum": 1000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Token for the next page of results", "examples": [ "MjAyNS0wOS0yM1QxMjoxMTo0MC43ODcwODVaLDY5YmIxYmFiLWE1NzAtNGU5Ny04MzE2LWFkYzQxYjk2Y2QyNA==" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "skip": { "description": "Number of items to skip before starting to collect results", "examples": [ 20 ], "format": "int64", "maximum": 1000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Pagination parameters for list requests." }, "cases.v1.PaginationResponse": { "title": "Pagination response", "type": "object", "properties": { "nextPageToken": { "description": "Token for the next page of results", "examples": [ "MjAyNS0wOS0yM1QxMjoxMTo0MC43ODcwODVaLDY5YmIxYmFiLWE1NzAtNGU5Ny04MzE2LWFkYzQxYjk2Y2QyNA==" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Pagination information for list responses." }, "cases.v1.UserDetails": { "title": "User details", "type": "object", "properties": { "userId": { "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 user identifier", "examples": [ "3af152ee-9eaf-4803-87f1-23c5fb2fbaa0" ] } }, "description": "Minimal user identity information used in case assignments." }, "common.Aggregation": { "enum": [ "AGGREGATION_UNSPECIFIED", "AGGREGATION_LAST", "AGGREGATION_MIN", "AGGREGATION_MAX", "AGGREGATION_AVG", "AGGREGATION_SUM" ], "type": "string", "description": "Aggregation." }, "common.DataprimeQuery": { "type": "object", "properties": { "text": { "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The text." } }, "description": "Line chart.dataprime query." }, "common.Threshold": { "title": "Threshold", "type": "object", "properties": { "color": { "description": "Color of the threshold", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "from": { "description": "Minimum bound value of the threshold", "format": "double", "type": "number", "x-coralogix-presence": true }, "label": { "description": "Optional label of the threshold", "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Definition of a single gauge threshold" }, "common.ThresholdBy": { "enum": [ "THRESHOLD_BY_UNSPECIFIED", "THRESHOLD_BY_VALUE", "THRESHOLD_BY_BACKGROUND" ], "type": "string", "description": "Threshold by." }, "common.Unit": { "enum": [ "UNIT_UNSPECIFIED", "UNIT_MICROSECONDS", "UNIT_MILLISECONDS", "UNIT_SECONDS", "UNIT_BYTES", "UNIT_KBYTES", "UNIT_MBYTES", "UNIT_GBYTES", "UNIT_BYTES_IEC", "UNIT_KIBYTES", "UNIT_MIBYTES", "UNIT_GIBYTES", "UNIT_EUR_CENTS", "UNIT_EUR", "UNIT_USD_CENTS", "UNIT_USD", "UNIT_NANOSECONDS", "UNIT_CUSTOM", "UNIT_PERCENT_ZERO_ONE", "UNIT_PERCENT_ZERO_HUNDRED", "UNIT_PERCENT", "UNIT_DATETIME_ISO" ], "type": "string", "description": "Unit." }, "events.v3.FilterMatcher": { "enum": [ "FILTER_MATCHER_TEXT_OR_UNSPECIFIED", "FILTER_MATCHER_REGEXP" ], "type": "string" }, "events.v3.OrderByDirection": { "enum": [ "ORDER_BY_DIRECTION_UNSPECIFIED", "ORDER_BY_DIRECTION_ASC", "ORDER_BY_DIRECTION_DESC" ], "type": "string", "description": "Order by direction." }, "events.v3.OrderByFields": { "enum": [ "ORDER_BY_FIELDS_UNSPECIFIED", "ORDER_BY_FIELDS_TIMESTAMP" ], "type": "string", "description": "Order by fields." }, "events.v3.PaginationResponse": { "type": "object", "properties": { "nextPageToken": { "description": "Token for fetching the next page of results.", "examples": [ "test" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "totalSize": { "description": "Total number of results.", "examples": [ 10 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Pagination metadata returned alongside paginated list responses." }, "filters.Filter": { "title": "Filter", "type": "object", "properties": { "collapsed": { "description": "Indicates if the filter's UI representation should be collapsed or expanded.", "type": "boolean", "x-coralogix-presence": true }, "displayName": { "description": "A display name for the filter", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "enabled": { "description": "Indicates if the filter is currently enabled or not.", "type": "boolean", "x-coralogix-presence": true }, "id": { "allOf": [ { "$ref": "#/components/schemas/UUID" } ], "description": "Filter's unique identifier" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/Filter.WidgetScope" } ], "description": "Scope of the filter, defining which widgets the filter applies to." }, "source": { "allOf": [ { "$ref": "#/components/schemas/Filter.Source" } ], "description": "The source of the filter, which can be logs, spans, or metrics." } }, "externalDocs": { "description": "Discover how to filter and query data in Custom Dashboards by exploring our documentation.", "url": "https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/" } }, "incidents.v1.GetFilterValuesResponse": { "title": "Get filter values response", "required": [ "filtersValues" ], "type": "object", "properties": { "filtersValues": { "$ref": "#/components/schemas/IncidentQueryFiltersValues" } }, "description": "Response containing available filter values for incidents" }, "incidents.v1.MetaLabel": { "title": "Incident meta label", "type": "object", "properties": { "key": { "description": "The key.", "examples": [ "key" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "value": { "description": "The value.", "examples": [ "value" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Meta label." }, "incidents.v1.PaginationRequest": { "title": "Pagination request", "required": [ "pageSize" ], "type": "object", "properties": { "pageSize": { "description": "Number of items to return per page.", "examples": [ 10 ], "format": "int64", "maximum": 10000, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "pageToken": { "description": "Token for the next page of results", "examples": [ "next_page_token" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Pagination parameters for list requests" }, "incidents.v1.PaginationResponse": { "title": "Pagination response", "required": [ "totalSize" ], "type": "object", "properties": { "nextPageToken": { "description": "Token for the next page of results", "examples": [ "next_page_token" ], "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "totalSize": { "description": "Total number of items available", "examples": [ 100 ], "format": "int64", "maximum": 1000000000, "minimum": 0, "type": "integer", "x-coralogix-presence": true } }, "description": "Pagination information for list responses" }, "incidents.v1.UserDetails": { "title": "User details", "required": [ "userId" ], "type": "object", "properties": { "userId": { "description": "The user id.", "examples": [ "user_id" ], "maxLength": 300, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "User details." }, "logs2metrics.v2.Severity": { "enum": [ "SEVERITY_UNSPECIFIED", "SEVERITY_DEBUG", "SEVERITY_VERBOSE", "SEVERITY_INFO", "SEVERITY_WARNING", "SEVERITY_ERROR", "SEVERITY_CRITICAL" ], "type": "string", "description": "Severity." }, "meta_labels_protobuf.v1.MetaLabel": { "type": "object", "properties": { "id": { "description": "Unique identifier.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "key": { "minLength": 0, "type": "string", "description": "The key." }, "value": { "description": "The value.", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Meta label." }, "notification_center.ConditionType": { "type": "object", "oneOf": [ { "required": [ "matchEntityType" ], "type": "object" }, { "required": [ "matchEntityTypeAndSubType" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "matchEntityType" ], "type": "object" }, { "required": [ "matchEntityTypeAndSubType" ], "type": "object" } ] } } ], "properties": { "matchEntityType": { "$ref": "#/components/schemas/MatchEntityTypeCondition" }, "matchEntityTypeAndSubType": { "$ref": "#/components/schemas/MatchEntityTypeAndSubTypeCondition" } }, "description": "Field condition.condition type." }, "notification_center.ConnectorConfigField": { "title": "Connector Config Field", "required": [ "fieldName" ], "type": "object", "properties": { "fieldName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name." }, "value": { "maxLength": 20000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The value." } }, "description": "A connector configuration field" }, "notification_center.ConnectorType": { "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "SLACK", "GENERIC_HTTPS", "PAGERDUTY", "IBM_EVENT_NOTIFICATIONS", "SERVICE_NOW", "EMAIL", "PAGERDUTY_INCIDENTS", "MICROSOFT_TEAMS", "EVENTBRIDGE", "INCIDENT_IO" ], "type": "string", "description": "Connector type." }, "notification_center.EntityType": { "enum": [ "ENTITY_TYPE_UNSPECIFIED", "ALERTS", "TEST_NOTIFICATIONS", "CASES", "OLLY_SCHEDULED_TASKS" ], "type": "string", "description": "Entity type." }, "notification_center.MessageConfigField": { "title": "Message Config Field", "type": "object", "properties": { "fieldName": { "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The field name.", "examples": [ "title" ] }, "template": { "maxLength": 20000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The template.", "examples": [ "{{alert.status}} {{alertDef.priority}} - {{alertDef.name}}" ] } }, "description": "Message config field provides a way to define a template that can be used to render the notification content", "externalDocs": { "description": "Find out more about notification center", "url": "https://coralogix.com/docs/user-guides/notification-center/introduction/welcome/" } }, "quota.v1.Priority": { "enum": [ "PRIORITY_TYPE_UNSPECIFIED", "PRIORITY_TYPE_BLOCK", "PRIORITY_TYPE_LOW", "PRIORITY_TYPE_MEDIUM", "PRIORITY_TYPE_HIGH" ], "type": "string", "description": "TCO priority level assigned to a policy, controlling how data is routed and archived." }, "quota.v1.Rule": { "type": "object", "properties": { "name": { "description": "The value(s) to match. For IS and IS_NOT rules, up to 50 comma-separated values. The service stores the values in lower case.", "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "ruleTypeId": { "$ref": "#/components/schemas/RuleTypeId" } }, "description": "Rule." }, "quota.v1.Severity": { "enum": [ "SEVERITY_UNSPECIFIED", "SEVERITY_DEBUG", "SEVERITY_VERBOSE", "SEVERITY_INFO", "SEVERITY_WARNING", "SEVERITY_ERROR", "SEVERITY_CRITICAL" ], "type": "string" }, "rbac.v2.User": { "title": "User", "type": "object", "properties": { "accessType": { "allOf": [ { "$ref": "#/components/schemas/AccessType" } ], "description": "Access type configuration - defines whether user access is permanent or temporary with expiration" }, "allowedLoginMode": { "maxItems": 2, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AllowedLoginMode" }, "description": "List of allowed login modes. Can include SSO, local authentication, or both." }, "firstName": { "minLength": 0, "type": "string", "description": "User first name" }, "groupIds": { "minItems": 0, "type": "array", "items": { "minimum": 0, "type": "integer", "description": "IDs of the team groups this user is a member of.", "format": "int64" }, "description": "IDs of the team groups this user is a member of." }, "lastName": { "minLength": 0, "type": "string", "description": "User last name" }, "status": { "allOf": [ { "$ref": "#/components/schemas/UserStatus" } ], "description": "User status: [Active, Inactive]" }, "userAccountId": { "minimum": 0, "type": "integer", "description": "Associated account id. An account can have many users.", "format": "int64" }, "userId": { "minLength": 0, "type": "string", "description": "Unique user id" }, "username": { "minLength": 0, "type": "string", "description": "Unique username" } }, "description": "A user is an entity that is always part of a team and has an account associated with it" }, "rules.v1.Rule": { "required": [ "id", "name", "description", "sourceField", "parameters", "enabled", "order" ], "type": "object", "properties": { "description": { "description": "Human-readable description. Defaults to an empty string.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "enabled": { "default": true, "description": "Whether the rule is enabled. Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "id": { "description": "Unique identifier. Set by the server, and regenerated for every rule on each update of the group.", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "name": { "description": "Display name. Must not be empty.", "minLength": 1, "type": "string", "x-coralogix-presence": true }, "order": { "description": "Position of the rule in its subgroup, starting at 1. Get returns the rules sorted by order.", "format": "int64", "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "parameters": { "$ref": "#/components/schemas/RuleParameters" }, "sourceField": { "description": "The field the rule reads: `text`, a `text.` path, or one of `applicationName`, `subsystemName`, `computerName`, `category`, `className`, `methodName`, `threadId`, and `severity`. A rule that deletes its source field must read a `text.` path.", "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "A parsing rule. Get returns every field." }, "scopes.v1.Filter": { "title": "Filter", "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/v1.EntityType" }, "expression": { "minLength": 0, "type": "string", "description": "The expression.", "examples": [ "true" ] } }, "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "v1.ConnectorType": { "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "CONNECTOR_TYPE_SLACK", "CONNECTOR_TYPE_SERVICE_NOW", "CONNECTOR_TYPE_PAGER_DUTY", "CONNECTOR_TYPE_EMAIL", "CONNECTOR_TYPE_GENERIC_HTTPS", "CONNECTOR_TYPE_MICROSOFT_TEAMS" ], "type": "string", "description": "Connector type." }, "v1.Duration": { "required": [ "frequency" ], "type": "object", "properties": { "forOver": { "type": "integer", "description": "The for over.", "format": "int32" }, "frequency": { "$ref": "#/components/schemas/DurationFrequency" } }, "description": "Duration." }, "v1.EntityType": { "enum": [ "ENTITY_TYPE_UNSPECIFIED", "ENTITY_TYPE_LOGS", "ENTITY_TYPE_SPANS" ], "type": "string", "description": "Entity type." }, "v1.Extension": { "title": "Extension metadata", "type": "object", "properties": { "changelog": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ChangelogEntry" }, "description": "The changelog.", "default": [] }, "darkModeImage": { "description": "The dark mode image.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "deprecation": { "$ref": "#/components/schemas/Deprecation" }, "id": { "description": "Unique identifier of the extension.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "image": { "description": "Image reference.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "integrations": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The integrations." }, "description": "The integrations.", "default": [] }, "isHidden": { "default": false, "description": "The is hidden.", "type": "boolean", "x-coralogix-presence": true }, "keywords": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "The keywords." }, "description": "The keywords.", "default": [] }, "name": { "description": "Display name of the extension.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "permissionDeniedRevisions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionRevision" }, "description": "The permission denied revisions.", "default": [] }, "revisions": { "maxItems": 10000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtensionRevision" }, "description": "The revisions.", "default": [] } }, "description": "Represents a Coralogix extension package containing pre-built resources." }, "v1.Failure": { "title": "Failure", "type": "object", "properties": { "errorMessage": { "description": "The error message.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Failure." }, "v1.FilterOperator": { "enum": [ "FILTER_OPERATOR_OR_OR_UNSPECIFIED", "FILTER_OPERATOR_AND" ], "type": "string", "description": "Filter operator." }, "v1.GetEventResponse": { "title": "Get event response", "required": [ "event" ], "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/CaseEvent" } ], "description": "The requested event" } }, "description": "Response containing the details of a case event." }, "v1.Grouping": { "title": "Grouping", "type": "object", "properties": { "labels": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of labels." }, "description": "List of labels." } }, "description": "Definition of the SLO grouping fields" }, "v1.IntegrationType": { "title": "Integration type", "type": "object", "oneOf": [ { "required": [ "managed" ], "type": "object" }, { "required": [ "untracked" ], "type": "object" }, { "required": [ "cloudformation" ], "type": "object" }, { "required": [ "arm" ], "type": "object" }, { "required": [ "pushBasedContextualData" ], "type": "object" }, { "required": [ "contextualData" ], "type": "object" }, { "required": [ "genericWebhook" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "managed" ], "type": "object" }, { "required": [ "untracked" ], "type": "object" }, { "required": [ "cloudformation" ], "type": "object" }, { "required": [ "arm" ], "type": "object" }, { "required": [ "pushBasedContextualData" ], "type": "object" }, { "required": [ "contextualData" ], "type": "object" }, { "required": [ "genericWebhook" ], "type": "object" } ] } } ], "properties": { "arm": { "$ref": "#/components/schemas/AzureArm" }, "cloudformation": { "$ref": "#/components/schemas/Cloudformation" }, "contextualData": { "$ref": "#/components/schemas/ContextualData" }, "genericWebhook": { "$ref": "#/components/schemas/GenericWebhook" }, "managed": { "$ref": "#/components/schemas/Managed" }, "pushBasedContextualData": { "$ref": "#/components/schemas/PushBasedContextualData" }, "untracked": { "$ref": "#/components/schemas/Untracked" } } }, "v1.KeyValue": { "title": "Key-value pair", "required": [ "key", "value" ], "type": "object", "properties": { "key": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Key of the pair (e.g., label or grouping name)", "examples": [ "service" ] }, "value": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Value associated with the key", "examples": [ "payments" ] } }, "description": "Represents a simple key-value pair, often used for labels or groupings in cases." }, "v1.ListEventsResponse": { "title": "List events response", "required": [ "events" ], "type": "object", "properties": { "events": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CaseEvent" }, "description": "Events for the case" } }, "description": "Response containing a list of case events." }, "v1.OrderBy": { "title": "Incident order by", "required": [ "direction" ], "type": "object", "oneOf": [ { "required": [ "incidentField" ], "type": "object" }, { "required": [ "contextualLabel" ], "type": "object" } ], "properties": { "contextualLabel": { "description": "A contextual label key to order by.", "maxLength": 256, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "direction": { "$ref": "#/components/schemas/v1.OrderByDirection" }, "incidentField": { "$ref": "#/components/schemas/IncidentFields" } } }, "v1.OrderByDirection": { "enum": [ "ORDER_BY_DIRECTION_UNSPECIFIED", "ORDER_BY_DIRECTION_ASC", "ORDER_BY_DIRECTION_DESC" ], "type": "string", "description": "Order by direction." }, "v1.Revision": { "title": "Revision", "type": "object", "properties": { "revision": { "type": "integer", "description": "The revision.", "format": "int32", "examples": [ 1 ] }, "updateTime": { "description": "Timestamp of the last update.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "The revision of the slo, used to differentiate between different versions of the same SLO" }, "v1.RevisionSummary": { "type": "object", "properties": { "lifecycle": { "$ref": "#/components/schemas/RevisionLifecycle" }, "version": { "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Version number." } } }, "v1.Scope": { "title": "Scope", "type": "object", "properties": { "defaultExpression": { "minLength": 0, "type": "string", "description": "The default expression.", "examples": [ "true" ] }, "description": { "description": "Human-readable description.", "examples": [ "The best scope" ], "minLength": 0, "type": "string", "x-coralogix-presence": true }, "displayName": { "minLength": 0, "type": "string", "description": "The display name.", "examples": [ "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.", "examples": [ "60c82be2-413f-4b8e-8201-7f5c51e2ef2b" ] }, "teamId": { "type": "integer", "description": "Team identifier.", "format": "int32", "examples": [ 1234 ] } }, "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "v1.SourceType": { "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SOURCE_TYPE_LOGS", "SOURCE_TYPE_SPANS", "SOURCE_TYPE_RUM" ], "type": "string", "description": "Source type." }, "v1.Target": { "title": "Target", "type": "object", "properties": { "archiveRetention": { "allOf": [ { "$ref": "#/components/schemas/ArchiveRetention" } ], "description": "Optional archive retention configuration for the target. The service accepts it and does not store it: a target never returns it." }, "dataset": { "maxLength": 512, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The dataset.", "examples": [ "dataset1" ] }, "dataspace": { "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z](?:[A-Za-z0-9_]|\\.[A-Za-z0-9_])*$", "type": "string", "description": "The dataspace. Only `default` is supported, in any letter case; the service rejects another value with `400`. A log policy target reads back with the value as sent, and with `default` when it is omitted. Span and RUM policies reject targets in a request: a span policy reads back with one `spans` target in `default`, and a RUM policy with none.", "examples": [ "default" ] }, "priority": { "allOf": [ { "$ref": "#/components/schemas/quota.v1.Priority" } ], "description": "The base priority for the target.", "examples": [ "PRIORITY_TYPE_MEDIUM" ], "x-coralogix-presence": true }, "priorityOverride": { "allOf": [ { "$ref": "#/components/schemas/PriorityOverride" } ], "description": "Optional quota-based tiered priority override for the target." } }, "description": "This data structure represents a target for quota policies. It defines a named group of datasets with a priority level and optional archive retention configuration.", "externalDocs": { "description": "Find out more about quota management.", "url": "https://coralogix.com/docs/user-guides/account-management/payment-and-billing/quota-management/" } }, "v1.TeamId": { "type": "object", "properties": { "id": { "minimum": 0, "type": "integer", "description": "Unique identifier.", "format": "int64" } }, "description": "Team id. Ignored: the service takes the team from the credentials of the request." }, "v1.TimeRange": { "title": "Time range", "required": [ "startTime", "endTime" ], "type": "object", "properties": { "endTime": { "description": "End time of the range", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "startTime": { "description": "Start time of the range", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "description": "Represents a time range with start and end timestamps" }, "v1.common.DataModeType": { "enum": [ "DATA_MODE_TYPE_HIGH_UNSPECIFIED", "DATA_MODE_TYPE_ARCHIVE" ], "type": "string", "description": "Data mode type. Omitted or DATA_MODE_TYPE_HIGH_UNSPECIFIED queries high-priority ('Frequent Search') data; DATA_MODE_TYPE_ARCHIVE queries archive ('Monitoring') data." }, "v2.Action": { "type": "object", "properties": { "applicationNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The application names." }, "description": "The application names." }, "createdBy": { "description": "The creating user's username. Set by the server; ignored on requests. Absent for an action that an API key created.", "maxLength": 255, "minLength": 0, "pattern": "^[\\s\\S]*$", "readOnly": true, "type": "string", "x-coralogix-presence": true }, "description": { "description": "Human-readable description.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dpxlFilter": { "description": "The dpxl filter. The server stores a non-empty filter with the version prefix, for example ` $d.severity == 'ERROR'`. An empty string stays empty.", "maxLength": 65535, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "id": { "description": "Unique identifier.", "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", "x-coralogix-presence": true }, "isHidden": { "default": false, "description": "A per-user UI preference that hides the action. Replace requires it and ignores a changed value, and Create does not take it. Defaults to false.", "type": "boolean", "x-coralogix-presence": true }, "isPrivate": { "default": true, "description": "Whether only the creating user sees the action. Replace requires it and cannot change it (412 Precondition Failed). A private action needs a user, so a request with an API key can create only shared actions (false). Defaults to true.", "type": "boolean", "x-coralogix-presence": true }, "name": { "description": "Display name.", "maxLength": 50, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "sourceType": { "$ref": "#/components/schemas/v2.SourceType" }, "subsystemNames": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 1024, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The subsystem names." }, "description": "The subsystem names." }, "url": { "description": "URL. Must start with http:// or https://.", "maxLength": 32768, "minLength": 1, "pattern": "^https?://.*$", "type": "string", "x-coralogix-presence": true }, "urlFields": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/UrlField" }, "description": "The url fields. Each field requires both name and required, and names must be unique within the list." } } }, "v2.Aggregation": { "title": "Aggregation", "required": [ "aggType", "targetMetricName" ], "type": "object", "oneOf": [ { "required": [ "none" ], "type": "object" }, { "required": [ "samples" ], "type": "object" }, { "required": [ "histogram" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "none" ], "type": "object" }, { "required": [ "samples" ], "type": "object" }, { "required": [ "histogram" ], "type": "object" } ] } } ], "properties": { "aggType": { "$ref": "#/components/schemas/AggType" }, "enabled": { "type": "boolean", "description": "Whether this resource is enabled." }, "histogram": { "allOf": [ { "$ref": "#/components/schemas/E2MAggHistogram" } ], "description": "e2m aggregate histogram type metadata" }, "none": { "type": "object", "description": "Marker indicating no additional metadata is needed for this aggregation type." }, "samples": { "$ref": "#/components/schemas/E2MAggSamples" }, "targetMetricName": { "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "description": "Name of the target metric produced by this aggregation.", "examples": [ "alias_field_name_agg_func" ] } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "v2.LogsQuery": { "title": "SpansQuery", "type": "object", "properties": { "alias": { "description": "The alias.", "examples": [ "new_query" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "applicationnameFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The applicationname filters.", "examples": [ "app_name" ] }, "description": "The applicationname filters." }, "lucene": { "description": "The lucene.", "examples": [ "log_obj.numeric_field: [50 TO 100]" ], "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "severityFilters": { "maxItems": 7, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/logs2metrics.v2.Severity" }, "description": "The severity filters." }, "subsystemnameFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The subsystemname filters.", "examples": [ "sub_name" ] }, "description": "The subsystemname filters." } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "v2.MetricField": { "title": "Metric Field", "required": [ "targetBaseMetricName", "sourceField", "aggregations" ], "type": "object", "properties": { "aggregations": { "maxItems": 7, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v2.Aggregation" }, "description": "The aggregations." }, "sourceField": { "description": "The source field.", "examples": [ "log_obj.numeric_field" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "targetBaseMetricName": { "description": "The target base metric name.", "examples": [ "alias_field_name" ], "maxLength": 255, "minLength": 1, "pattern": "^[\\w/-]+$", "type": "string", "x-coralogix-presence": true } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "v2.Permissions": { "type": "object", "properties": { "permissions": { "minItems": 0, "type": "array", "items": { "minLength": 0, "type": "string", "description": "List of permissions." }, "description": "List of permissions." } }, "description": "Permissions." }, "v2.Scope": { "title": "Scope", "type": "object", "properties": { "scopeId": { "minLength": 0, "type": "string", "description": "Reference to an existing scope by ID" } }, "description": "Scope assignment for a group. References an existing scope by ID. Scopes can be created via the Scopes API.", "externalDocs": { "description": "Find out more about scopes", "url": "https://coralogix.com/docs/user-guides/account-management/user-management/scopes/" } }, "v2.SetActiveResponse": { "type": "object", "additionalProperties": false, "description": "Response returned after updating the SAML active state." }, "v2.SourceType": { "enum": [ "SOURCE_TYPE_UNSPECIFIED", "SOURCE_TYPE_LOG", "SOURCE_TYPE_DATA_MAP" ], "type": "string", "description": "Source type." }, "v2.SpansQuery": { "title": "SpansQuery", "type": "object", "properties": { "actionFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The action filters.", "examples": [ "myAction" ] }, "description": "The action filters." }, "applicationnameFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The applicationname filters.", "examples": [ "myApp" ] }, "description": "The applicationname filters." }, "lucene": { "description": "The lucene.", "examples": [ "applicationName:myApp" ], "maxLength": 10000, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "serviceFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The service filters.", "examples": [ "myService" ] }, "description": "The service filters." }, "subsystemnameFilters": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "maxLength": 4096, "minLength": 0, "pattern": "^[\\s\\S]*$", "type": "string", "description": "The subsystemname filters.", "examples": [ "mySubsystem" ] }, "description": "The subsystemname filters." } }, "externalDocs": { "description": "Find out more about events2metrics", "url": "https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/" } }, "v2.Target": { "title": "Target", "required": [ "archiveSpec" ], "type": "object", "oneOf": [ { "required": [ "s3" ], "type": "object" }, { "required": [ "ibmCos" ], "type": "object" } ], "properties": { "archiveSpec": { "$ref": "#/components/schemas/ArchiveSpec" }, "ibmCos": { "$ref": "#/components/schemas/IBMCosTargetSpec" }, "s3": { "$ref": "#/components/schemas/S3TargetSpec" } }, "externalDocs": { "description": "Find out more about archives", "url": "https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/" } }, "v2.TeamId": { "type": "object", "properties": { "id": { "maximum": 4294967295, "minimum": 0, "type": "integer", "description": "Unique team identifier.", "format": "int64" } }, "description": "Team id." }, "v3.ApiKey": { "title": "API Key", "type": "object", "properties": { "createdAt": { "description": "The timestamp when the API key was created.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "id": { "minLength": 0, "type": "string", "description": "Unique identifier.", "examples": [ "key_abc123" ] }, "isActive": { "type": "boolean", "description": "Whether this resource is active." }, "keyName": { "minLength": 0, "type": "string", "description": "The key name.", "examples": [ "my_api_key" ] }, "lastActivated": { "description": "The timestamp when the API key was last activated.", "format": "date-time", "minLength": 0, "type": "string", "x-coralogix-presence": true }, "owner": { "$ref": "#/components/schemas/ApiKeyOwner" } }, "externalDocs": { "description": "Find out more about api keys", "url": "https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/" } }, "v3.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." }, "v3.ConnectorConfigField": { "title": "Connector config field", "type": "object", "properties": { "fieldName": { "minLength": 0, "type": "string", "description": "The name of the configuration field", "examples": [ "description" ] }, "template": { "minLength": 0, "type": "string", "description": "The template for the configuration field", "examples": [ "template_example" ] } } }, "v3.FilterOperator": { "enum": [ "FILTER_OPERATOR_AND_OR_UNSPECIFIED", "FILTER_OPERATOR_OR" ], "type": "string", "description": "Filter operator." }, "v3.GetEventResponse": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CxEventSingleOrMultiple" }, "pagination": { "$ref": "#/components/schemas/events.v3.PaginationResponse" } }, "description": "Response containing the details of an alert event." }, "v3.IntegrationType": { "title": "Integration type", "type": "object", "oneOf": [ { "required": [ "integrationId" ], "type": "object" }, { "required": [ "recipients" ], "type": "object" }, { "type": "object", "not": { "anyOf": [ { "required": [ "integrationId" ], "type": "object" }, { "required": [ "recipients" ], "type": "object" } ] } } ], "properties": { "integrationId": { "description": "The integration ID for the notification", "examples": [ 123 ], "format": "int64", "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "recipients": { "allOf": [ { "$ref": "#/components/schemas/Recipients" } ], "description": "The recipients for the notification." } }, "description": "Defines the type of integration to use for notifications" }, "v3.ListEventsResponse": { "title": "ListEventsResponse", "required": [ "events" ], "type": "object", "properties": { "events": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/CxEvent" }, "description": "List of events." }, "pagination": { "$ref": "#/components/schemas/events.v3.PaginationResponse" } } }, "v3.LogsFilter": { "title": "Log filter", "type": "object", "properties": { "simpleFilter": { "allOf": [ { "$ref": "#/components/schemas/LogsSimpleFilter" } ], "description": "A simple filter that uses a Lucene query and label filters" } }, "description": "Filter configuration for log-based alerts" }, "v3.MessageConfigField": { "title": "Message config field", "type": "object", "properties": { "fieldName": { "minLength": 0, "type": "string", "description": "The name of the configuration field", "examples": [ "description" ] }, "template": { "minLength": 0, "type": "string", "description": "The template for the configuration field", "examples": [ "template_example" ] } }, "description": "Configuration field for a notification message" }, "v3.Permutation": { "title": "Permutation data structure", "type": "object", "properties": { "permutationLabels": { "type": "object", "additionalProperties": { "minLength": 0, "type": "string" }, "description": "Labels for the permutation." } } }, "v3.SloDefinition": { "title": "SLO Definition", "type": "object", "properties": { "sloId": { "description": "The SLO ID", "examples": [ "123e4567-e89b-12d3-a456-426614174000" ], "maxLength": 36, "minLength": 1, "type": "string", "x-coralogix-presence": true } }, "description": "Configuration for SLO definition" }, "v3.SourceOverrides": { "title": "Source overrides", "type": "object", "properties": { "connectorConfigFields": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v3.ConnectorConfigField" }, "description": "Connector configuration fields" }, "messageConfigFields": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/v3.MessageConfigField" }, "description": "Notification message configuration fields" }, "payloadType": { "minLength": 0, "type": "string", "description": "the payload type for the notification", "examples": [ "slack_raw, slack_structured, pagerduty_triggered, pagerduty_resolved, generic_https_default" ] } }, "description": "Source overrides." }, "v3.TimeRange": { "title": "Time range", "type": "object", "properties": { "endTime": { "description": "End time of the range", "format": "date-time", "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "startTime": { "description": "Start time of the range", "format": "date-time", "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "description": "Represents a time range with start and end timestamps" }, "v3.UndetectedValuesManagement": { "title": "Undetected value management", "type": "object", "properties": { "autoRetireTimeframe": { "allOf": [ { "$ref": "#/components/schemas/v3.AutoRetireTimeframe" } ], "description": "The timeframe for auto-retiring the alert when undetected values are detected", "examples": [ "AUTO_RETIRE_TIMEFRAME_HOURS_24" ], "x-coralogix-presence": true }, "triggerUndetectedValues": { "description": "Should trigger the alert when undetected values are detected", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true } }, "description": "Configuration for handling undetected values in alerts" }, "views.v1.Filter": { "title": "ViewFolder", "required": [ "name" ], "type": "object", "properties": { "name": { "description": "Filter name", "examples": [ "applicationName" ], "maxLength": 65535, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "selectedValues": { "type": "object", "additionalProperties": { "type": "boolean" }, "description": "Filter values to select, each set to true. The service keeps only the values set to true and drops a value set to false." } }, "description": "View folder." }, "widgets.BarValueDisplay": { "enum": [ "BAR_VALUE_DISPLAY_UNSPECIFIED", "BAR_VALUE_DISPLAY_TOP", "BAR_VALUE_DISPLAY_INSIDE", "BAR_VALUE_DISPLAY_BOTH" ], "type": "string", "description": "Bar value display." }, "widgets.Dynamic": { "type": "object", "properties": { "interpretation": { "allOf": [ { "$ref": "#/components/schemas/Interpretation" } ], "description": "Interpretation of the query results (deprecated, use visualization instead)", "deprecated": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/Dynamic.Query" } ], "description": "A query object describing how to retrieve data", "deprecated": true }, "queryDefinitions": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Dynamic.QueryDefinition" }, "description": "Definitions of widget queries. At least one query definition is required unless the deprecated query field is set." }, "timeFrame": { "allOf": [ { "$ref": "#/components/schemas/TimeFrameSelect" } ], "description": "Time frame which overrides the dashboard time frame" }, "visualization": { "allOf": [ { "$ref": "#/components/schemas/Visualization" } ], "description": "Specifies how the query results should be visualized" } }, "description": "Dynamic." }, "widgets.Gauge": { "type": "object", "properties": { "arcDisplay": { "allOf": [ { "$ref": "#/components/schemas/ArcDisplay" } ], "description": "Arc display settings; set this object to show the gauge arcs and control the value and threshold arcs, or omit it to hide all arcs" }, "customUnit": { "description": "Custom unit (requires to have unit field set as 'custom' to take effect)", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 3 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "displaySeriesName": { "description": "(multigauge display only) Whether to show the series names above the value", "type": "boolean", "x-coralogix-presence": true }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "legendBy": { "allOf": [ { "$ref": "#/components/schemas/LegendBy" } ], "description": "(multigauge display only) Indicates how to group the legend elements, either by thresholds or by standard groups" }, "max": { "description": "A maximum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 150000 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "min": { "description": "A minimum gauge value used in percentage threshold calculation and for visual value representation", "examples": [ 0 ], "format": "double", "type": "number", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/Gauge.Query" } ], "description": "A query object containing query definition" }, "showInnerArc": { "deprecated": true, "description": "Deprecated: use arcDisplay.valueArc instead. Whether to show the inner arc of gauge which graphically represents the value", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "showMinMax": { "description": "Whether to display the min and max range values on the gauge", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "showOuterArc": { "deprecated": true, "description": "Deprecated: use arcDisplay.thresholdArc instead. Whether to show the outer arc of gauge which graphically represents the min/max range", "examples": [ true ], "type": "boolean", "x-coralogix-presence": true }, "thresholdBy": { "allOf": [ { "$ref": "#/components/schemas/Gauge.ThresholdBy" } ], "description": "Indicates which widget element should be colorized as the threshold, either the value or the background" }, "thresholdType": { "allOf": [ { "$ref": "#/components/schemas/ThresholdType" } ], "description": "Type of the threshold, relative or absolute" }, "thresholds": { "maxItems": 1000, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Gauge.Threshold" }, "description": "List of value thresholds, each with a certain color and an optional name label" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Gauge.Unit" } ], "description": "Unit of the value - one from a predefined list, or 'custom'", "examples": [ "3" ] } }, "description": "Gauge." }, "widgets.PieChart": { "type": "object", "properties": { "colorScheme": { "description": "Applied color scheme, one of the predefined values", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "customUnit": { "description": "Custom unit (requires the unit field to be set to custom to take effect)", "maxLength": 255, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "dataModeType": { "allOf": [ { "$ref": "#/components/schemas/widgets.common.DataModeType" } ], "description": "Data mode type, either high or archive" }, "decimal": { "description": "Number indicating the decimal precision of the numeric values, within range 0-15", "examples": [ 5 ], "format": "int32", "maximum": 15, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "decimalPrecision": { "description": "Whether to render numeric value without abbreviation", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "groupNameTemplate": { "description": "Custom template name for a group, can contain variables", "maxLength": 4096, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true }, "hashColors": { "description": "Whether to ignore color scheme and derive colors from algorithm", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "labelDefinition": { "allOf": [ { "$ref": "#/components/schemas/widgets.PieChart.LabelDefinition" } ], "description": "Settings for slice labels" }, "legend": { "allOf": [ { "$ref": "#/components/schemas/Legend" } ], "description": "Widget's legend settings" }, "maxSlicesPerChart": { "description": "Maximum number of slices on a chart", "examples": [ 24 ], "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer", "x-coralogix-presence": true }, "minSlicePercentage": { "description": "Minimum percentage threshold for slices to be displayed", "examples": [ 5 ], "format": "int32", "maximum": 100, "minimum": 0, "type": "integer", "x-coralogix-presence": true }, "query": { "allOf": [ { "$ref": "#/components/schemas/PieChart.Query" } ], "description": "Query object" }, "showLegend": { "description": "Indicates whether to display the legend", "type": "boolean", "x-coralogix-presence": true }, "showTotal": { "description": "Whether to show the total amount as a title", "examples": [ false ], "type": "boolean", "x-coralogix-presence": true }, "stackDefinition": { "allOf": [ { "$ref": "#/components/schemas/PieChart.StackDefinition" } ], "description": "Configuration of stacked slices" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/common.Unit" } ], "description": "Unit of the value - one from a predefined list, or custom", "examples": [ "0" ] } }, "description": "Pie chart." }, "widgets.PieChart.LabelDefinition": { "type": "object", "properties": { "isVisible": { "description": "Are labels visible", "type": "boolean", "x-coralogix-presence": true }, "labelSource": { "allOf": [ { "$ref": "#/components/schemas/widgets.PieChart.LabelSource" } ], "description": "Source of the label" }, "showName": { "description": "Whether to show the name of slice in the label", "type": "boolean", "x-coralogix-presence": true }, "showPercentage": { "description": "Whether to show percentage value of slice in the label", "type": "boolean", "x-coralogix-presence": true }, "showValue": { "description": "Whether to show value of slice in the label", "type": "boolean", "x-coralogix-presence": true } }, "description": "Label definition." }, "widgets.PieChart.LabelSource": { "enum": [ "LABEL_SOURCE_UNSPECIFIED", "LABEL_SOURCE_INNER", "LABEL_SOURCE_STACK" ], "type": "string", "description": "Label source." }, "widgets.common.DataModeType": { "enum": [ "DATA_MODE_TYPE_HIGH_UNSPECIFIED", "DATA_MODE_TYPE_ARCHIVE" ], "type": "string", "description": "Data mode type." } }, "parameters": { "case_id": { "name": "case_id", "in": "path", "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`).", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ] } }, "dashboard_id": { "name": "dashboard_id", "in": "path", "description": "The dashboard id.", "required": true, "schema": { "description": "The dashboard id.", "maxLength": 21, "minLength": 21, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "event_id": { "name": "event_id", "in": "path", "description": "Event ID associated to the Incident to acknowledge", "required": true, "schema": { "description": "Event ID associated to the Incident to acknowledge", "examples": [ "event_id_1" ], "maxLength": 64, "minLength": 1, "pattern": "^[\\s\\S]*$", "type": "string", "x-coralogix-presence": true } }, "id": { "name": "id", "in": "path", "description": "Configuration group UUID v7.", "required": true, "schema": { "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.", "examples": [ "01975ed4-9c1a-7b3f-8d4e-426614174000" ] } }, "id_2": { "name": "id", "in": "path", "description": "Configuration overlay UUID v7.", "required": true, "schema": { "maxLength": 36, "minLength": 36, "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "type": "string", "description": "Configuration overlay UUID v7." } }, "id_3": { "name": "id", "in": "path", "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`).", "required": true, "schema": { "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`).", "examples": [ "3f166e9f-3c88-4af2-b52e-138f339dab3e" ] } }, "id_4": { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "description": "Unique identifier.", "examples": [ "example_id" ], "minLength": 0, "type": "string", "x-coralogix-presence": true } }, "id_5": { "name": "id", "in": "path", "description": "Unique identifier.", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "type": "string", "description": "Unique identifier." } }, "key_id": { "name": "key_id", "in": "path", "description": "Key identifier.", "required": true, "schema": { "minLength": 0, "type": "string", "description": "Key identifier.", "examples": [ "my_key_id" ] } } }, "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "API key authentication" } } }, "servers": [ { "url": "https://api.eu1.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.eu2.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.us1.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.us2.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.us3.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.ap1.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.ap2.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.ap3.coralogix.com/mgmt/openapi/5" }, { "url": "https://api.gov1.coralogixgov.us/mgmt/openapi/5" } ], "externalDocs": { "description": "Coralogix API reference", "url": "https://coralogix.com/docs/api-reference/v5/" } }