{ "openapi": "3.0.0", "info": { "title": "Cloud Logs API", "version": "0.1.0", "x-ibm-name": "logs", "x-alternate-name": "logs", "x-codegen-config": { "cli": { "apiPackage": "github.com/observability-c/dragonlog-cli", "cliPluginName": "cloud-logs", "confirmDeleteOperations": true, "createServiceUrlFlag": true, "privateEndpointSupported": true, "serviceCommandAliases": [ "logs" ], "singleServicePlugin": true }, "go": { "apiPackage": "github.com/observability-c/dragonlog-logs-go-sdk" }, "python": { "apiPackage": "ibm_logs" } }, "x-cli-description": "Manage the IBM Cloud Logs Service.", "x-github": "https://github.ibm.com/cloud-api-docs/cloud-logs", "x-github-issues": "https://github.ibm.com/cloud-api-docs/cloud-logs/issues/new", "description": "## Introduction\n\nIBM® Cloud Logs is a scalable logging service that persists logs and provides users with capabilities for querying, tailing, and visualizing logs.\n\nGo SDK is available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDK implement best practices for using the API and reduce the amount of code that you need to write. The tab for Go includes code examples that demonstrate how to use the client libraries. For more information about using the SDK, see the [IBM Cloud SDK Common project](https://github.com/IBM/ibm-cloud-sdk-common) on GitHub.\n\nInstalling the Go SDK\n\nGo modules (recommended): Add the following import in your code, and then run `go build` or `go mod tidy`\n\n```go\nimport (\n\t\"github.com/IBM/logs-go-sdk/logsv0\"\n)\n```\n\nGo get\n\n```bash\ngo get -u github.com/IBM/logs-go-sdk\n```\n\nView on GitHub\n\n[https://github.com/IBM/logs-go-sdk](https://github.com/IBM/logs-go-sdk)\n\n## Endpoint URLs\n\nThe API endpoint URL is unique per region for an instance of IBM Cloud Logs. For example, when IBM Cloud Logs is hosted in Madrid (eu-es), the base URL is https://{instance_ID}.api.eu-es.logs.cloud.ibm.com\n\nThe version information is appended to the base URL to access resources. For example /v1, resulting in the URL https://{instance_ID}.api.eu-es.logs.cloud.ibm.com/v1 for Madrid (eu-es).\n\nBase URL\n```bash\nhttps://{instance_ID}.api.{region}.logs.cloud.ibm.com\n```\n\nExample API request\n\n```bash\ncurl -X {request_method} \\\n -H \"Authorization: Bearer {bearer_token}\" \\\n -H \"Accept: application/json\" \\\n [--data \"{request_body}\"] \\\n \"https://{instance_ID}.api.{region}.logs.cloud.ibm.com/{method_endpoint}\"\n```\n\nReplace `{bearer_token}`, `{request_method}`, `{method_endpoint}` and [optional] `{request_body}` in this example with the values for your particular API call.\n\n## Authentication\n\nAuthorization to the IBM Cloud Logs service REST API is enforced by an IBM Cloud® Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.\n\nRetrieving an access token is supported using an IAM Trusted Profile or IAM API key.\n\n* To request an access token with a Trusted Profile from within your IBM Cloud Kubernetes Service or Red Hat OpenShift cluster, run the following command:\n\n ```bash\n curl -X POST \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n --data \"grant_type=urn:ibm:params:oauth:grant-type:cr-token\" \\\n --data \"profile_id={trusted_profile_id}\" \\\n --data-urlencode \"cr_token@{path_to_token}\" \\\n https://iam.cloud.ibm.com/identity/token\n ```\n \n\n Replace `{trusted_profile_id}` and `{path_to_token}` with the correct values for your environment.\n\n* To request an access token with an IAM api_key, run the following command:\n\n ```bash\n curl -X POST \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n --data \"grant_type=urn:ibm:params:oauth:grant-type:apikey\" \\\n --data \"apikey=${IAM_API_KEY}\" \\\n \"https://iam.cloud.ibm.com/identity/token\"\n ```\n \n\n Replace `{IAM_API_KEY}` with your IAM API key.\n\nThe access token is provided in the returned JSON data in the field `.access_token`.\n\n## Error handling\n\nThe IBM Cloud Logs service uses standard HTTP response codes to indicate whether a method completed successfully. A `200` response always indicates success. A `400` type response indicates that a parameter validation failed and can occur if required parameters are missing or if any parameter values are invalid. A `401` or `403` response indicates that the incoming request did not contain valid authentication information. A `500` type response indicates an internal server error that is seen in an unexpected error situation.\n\nThe IBM Cloud Logs REST APIs return standard HTTP status codes to indicate the success or failure of a request. The format of the response is represented in JSON as follows:\n\n```json\n{\n \"errors\": [\n {\n \"code\": \"not_authorized\",\n \"message\": \"The specified token does not have authority to create a tenant.\"\n }\n ],\n \"status_code\": 403\n}\n```\n\nIf an operation cannot be fulfilled, an appropriate 400 or 500 series HTTP response is returned from the server. The operations that are defined in the `Reference` section describe example errors that might be returned from a failed request. All responses from the Identity Services REST API are in JSON format.\n\nThe following table shows the potential error codes the API might return.\n\n| HTTP Error Code | Description | Recovery |\n|-----------------|-------------|----------|\n| `200` | Success | The request was successful. |\n| `201` | Created | The resource was successfully created. |\n| `204` | No Content | The request was successful. No response body is provided. |\n| `400` | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |\n| `401` | Unauthorized | You are not authorized to make this request. The token is either missing or expired. Get a new valid token and try again. |\n| `403` | Forbidden | The supplied authentication is not authorized to perform the operation. If this error persists, contact the account owner to check your permissions. |\n| `404` | Not Found | The requested resource can't be found. |\n| `408` | Request Timeout| The connection to the server timed out. Wait a few minutes, then try again. |\n| `409` | conflict | The requested resource conflicts with an already existing resource. |\n| `415` | Bad Request | Missing or wrong header |\n| `429` | Rate limit exceeded | Reduce the rate of requests or Wait a few minutes, then try again. |\n| `500` | Internal error | Error that is seen in an unexpected error situation. |", "x-last-updated": "2024-06-24" }, "paths": { "/v1/alert_definitions/{id}": { "get": { "tags": [ "Alert definitions" ], "summary": "Get an alert definition by ID", "description": "Get details of an existing alert by using the alert ID.", "operationId": "get_alert_def", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "alert-definition", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Priority:priority,Type:type,Created_Time:created_time}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/alert_definitions/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getAlertDefOptions := logsService.NewGetAlertDefOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "alertDefinition, response, err := logsService.GetAlertDef(getAlertDefOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alertDefinition, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Alert definitions" ], "summary": "Update an alert definition by ID", "description": "Update an alert definition", "operationId": "replace_alert_def", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinitionPrototype" }, "example": { "active_on": { "day_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "end_time": { "hours": 21, "minutes": 59 }, "start_time": { "hours": 22 } }, "deleted": false, "description": "Example Alert definition", "enabled": true, "entity_labels": {}, "group_by_keys": [], "incidents_settings": { "minutes": 10, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "more_than_or_unspecified", "logs_filter": { "simple_filter": { "label_filters": { "application_name": [], "severities": [], "subsystem_name": [] } } }, "notification_payload_filter": [], "rules": [ { "condition": { "threshold": 1, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ] }, "name": "Alert 1738141279354", "notification_group": { "group_by_keys": [], "webhooks": [] }, "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinition" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "alert-definition-update", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Priority:priority,Type:type,UpdatedTime:updated_time}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"active_on\": {\n", " \"day_of_week\": [\n", " \"sunday\",\n", " \"monday_or_unspecified\",\n", " \"tuesday\",\n", " \"wednesday\",\n", " \"thursday\",\n", " \"friday\",\n", " \"saturday\"\n", " ],\n", " \"end_time\": {\n", " \"hours\": 21,\n", " \"minutes\": 59\n", " },\n", " \"start_time\": {\n", " \"hours\": 22\n", " }\n", " },\n", " \"deleted\": false,\n", " \"description\": \"Example Alert definition\",\n", " \"enabled\": true,\n", " \"entity_labels\": {},\n", " \"group_by_keys\": [],\n", " \"incidents_settings\": {\n", " \"minutes\": 10,\n", " \"notify_on\": \"triggered_only_unspecified\"\n", " },\n", " \"logs_threshold\": {\n", " \"condition_type\": \"more_than_or_unspecified\",\n", " \"logs_filter\": {\n", " \"simple_filter\": {\n", " \"label_filters\": {\n", " \"application_name\": [],\n", " \"severities\": [],\n", " \"subsystem_name\": []\n", " }\n", " }\n", " },\n", " \"notification_payload_filter\": [],\n", " \"rules\": [\n", " {\n", " \"condition\": {\n", " \"threshold\": 1,\n", " \"time_window\": {\n", " \"logs_time_window_specific_value\": \"minutes_10\"\n", " }\n", " },\n", " \"override\": {\n", " \"priority\": \"p5_or_unspecified\"\n", " }\n", " }\n", " ]\n", " },\n", " \"name\": \"Alert 1738141279354\",\n", " \"notification_group\": {\n", " \"group_by_keys\": [],\n", " \"webhooks\": []\n", " },\n", " \"phantom_mode\": false,\n", " \"priority\": \"p5_or_unspecified\",\n", " \"type\": \"logs_threshold\"\n", " }' \\\n", " \"${base_url}/v1/alert_definitions/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisAlertDefinitionTimeOfDayModel := &logsv0.ApisAlertDefinitionTimeOfDay{\n", " Hours: core.Int64Ptr(int64(22)),\n", "}\n", "\n", "apisAlertDefinitionActivityScheduleModel := &logsv0.ApisAlertDefinitionActivitySchedule{\n", " DayOfWeek: []string{\"sunday\", \"monday_or_unspecified\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\"},\n", " StartTime: apisAlertDefinitionTimeOfDayModel,\n", " EndTime: apisAlertDefinitionTimeOfDayModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefIncidentSettingsModel := &logsv0.ApisAlertDefinitionAlertDefIncidentSettings{\n", " NotifyOn: core.StringPtr(\"triggered_only_unspecified\"),\n", " Minutes: core.Int64Ptr(int64(10)),\n", "}\n", "\n", "apisAlertDefinitionIntegrationTypeModel := &logsv0.ApisAlertDefinitionIntegrationTypeIntegrationTypeIntegrationID{\n", "}\n", "\n", "apisAlertDefinitionAlertDefWebhooksSettingsModel := &logsv0.ApisAlertDefinitionAlertDefWebhooksSettings{\n", " Integration: apisAlertDefinitionIntegrationTypeModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefNotificationGroupModel := &logsv0.ApisAlertDefinitionAlertDefNotificationGroup{\n", " GroupByKeys: []string{},\n", " Webhooks: []logsv0.ApisAlertDefinitionAlertDefWebhooksSettings{*apisAlertDefinitionAlertDefWebhooksSettingsModel},\n", "}\n", "\n", "apisAlertDefinitionLabelFilterTypeModel := &logsv0.ApisAlertDefinitionLabelFilterType{\n", " Operation: core.StringPtr(\"starts_with\"),\n", "}\n", "\n", "apisAlertDefinitionLabelFiltersModel := &logsv0.ApisAlertDefinitionLabelFilters{\n", " ApplicationName: []logsv0.ApisAlertDefinitionLabelFilterType{*apisAlertDefinitionLabelFilterTypeModel},\n", " SubsystemName: []logsv0.ApisAlertDefinitionLabelFilterType{*apisAlertDefinitionLabelFilterTypeModel},\n", " Severities: []string{},\n", "}\n", "\n", "apisAlertDefinitionLogsSimpleFilterModel := &logsv0.ApisAlertDefinitionLogsSimpleFilter{\n", " LabelFilters: apisAlertDefinitionLabelFiltersModel,\n", "}\n", "\n", "apisAlertDefinitionLogsFilterModel := &logsv0.ApisAlertDefinitionLogsFilter{\n", " SimpleFilter: apisAlertDefinitionLogsSimpleFilterModel,\n", "}\n", "\n", "apisAlertDefinitionLogsTimeWindowModel := &logsv0.ApisAlertDefinitionLogsTimeWindow{\n", " LogsTimeWindowSpecificValue: core.StringPtr(\"minutes_10\"),\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdConditionModel := &logsv0.ApisAlertDefinitionLogsThresholdCondition{\n", " Threshold: core.Float64Ptr(float64(1)),\n", " TimeWindow: apisAlertDefinitionLogsTimeWindowModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefOverrideModel := &logsv0.ApisAlertDefinitionAlertDefOverride{\n", " Priority: core.StringPtr(\"p5_or_unspecified\"),\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdRuleModel := &logsv0.ApisAlertDefinitionLogsThresholdRule{\n", " Condition: apisAlertDefinitionLogsThresholdConditionModel,\n", " Override: apisAlertDefinitionAlertDefOverrideModel,\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdTypeModel := &logsv0.ApisAlertDefinitionLogsThresholdType{\n", " LogsFilter: apisAlertDefinitionLogsFilterModel,\n", " Rules: []logsv0.ApisAlertDefinitionLogsThresholdRule{*apisAlertDefinitionLogsThresholdRuleModel},\n", " ConditionType: core.StringPtr(\"more_than_or_unspecified\"),\n", " NotificationPayloadFilter: []string{},\n", "}\n", "\n", "alertDefinitionPrototypeModel := &logsv0.AlertDefinitionPrototypeApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsThreshold{\n", " Name: core.StringPtr(\"Alert 1738141279354\"),\n", " Description: core.StringPtr(\"Example Alert definition\"),\n", " Enabled: core.BoolPtr(true),\n", " Priority: core.StringPtr(\"p5_or_unspecified\"),\n", " ActiveOn: apisAlertDefinitionActivityScheduleModel,\n", " Type: core.StringPtr(\"logs_threshold\"),\n", " GroupByKeys: []string{},\n", " IncidentsSettings: apisAlertDefinitionAlertDefIncidentSettingsModel,\n", " NotificationGroup: apisAlertDefinitionAlertDefNotificationGroupModel,\n", " PhantomMode: core.BoolPtr(false),\n", " Deleted: core.BoolPtr(false),\n", " LogsThreshold: apisAlertDefinitionLogsThresholdTypeModel,\n", "}\n", "\n", "replaceAlertDefOptions := logsService.NewReplaceAlertDefOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " alertDefinitionPrototypeModel,\n", ")\n", "\n", "alertDefinition, response, err := logsService.ReplaceAlertDef(replaceAlertDefOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alertDefinition, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Alert definitions" ], "summary": "Delete an alert definition by ID", "description": "Delete an alert definition", "operationId": "delete_alert_def", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "alert-definition-delete", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/alert_definitions/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteAlertDefOptions := logsService.NewDeleteAlertDefOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeleteAlertDef(deleteAlertDefOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteAlertDef(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "Alert definition ID", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Alert definition ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/AlertDefinitionID" } ] }, "/v1/alert_definitions": { "get": { "tags": [ "Alert definitions" ], "summary": "List alert definitions", "description": "List alert definitions", "operationId": "list_alert_defs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinitionCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "alert-definitions", "x-cli-table-filter-jmespath": "alert_definitions[*].{Name:name,ID:id,Enabled:enabled,Priority:priority,Type:type,Created_Time:created_time}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/alert_definitions\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listAlertDefsOptions := logsService.NewListAlertDefsOptions()\n", "\n", "alertDefinitionCollection, response, err := logsService.ListAlertDefs(listAlertDefsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alertDefinitionCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Alert definitions" ], "summary": "Create an alert definition", "description": "Create an alert definition", "operationId": "create_alert_def", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinitionPrototype" }, "example": { "active_on": { "day_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "end_time": { "hours": 21, "minutes": 59 }, "start_time": { "hours": 22 } }, "deleted": false, "description": "Example Alert definition", "enabled": true, "entity_labels": {}, "group_by_keys": [], "incidents_settings": { "minutes": 10, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "more_than_or_unspecified", "logs_filter": { "simple_filter": { "label_filters": { "application_name": [], "severities": [], "subsystem_name": [] } } }, "notification_payload_filter": [], "rules": [ { "condition": { "threshold": 1, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ] }, "name": "Alert 1738141279354", "notification_group": { "group_by_keys": [], "webhooks": [] }, "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertDefinition" } } }, "links": { "AlertDefinitionID": { "$ref": "#/components/links/AlertDefinitionID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "alert-definition-create", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Priority:priority,Type:type,Created_Time:created_time}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"active_on\": {\n", " \"day_of_week\": [\n", " \"sunday\",\n", " \"monday_or_unspecified\",\n", " \"tuesday\",\n", " \"wednesday\",\n", " \"thursday\",\n", " \"friday\",\n", " \"saturday\"\n", " ],\n", " \"end_time\": {\n", " \"hours\": 21,\n", " \"minutes\": 59\n", " },\n", " \"start_time\": {\n", " \"hours\": 22\n", " }\n", " },\n", " \"deleted\": false,\n", " \"description\": \"Example Alert definition\",\n", " \"enabled\": true,\n", " \"entity_labels\": {},\n", " \"group_by_keys\": [],\n", " \"incidents_settings\": {\n", " \"minutes\": 10,\n", " \"notify_on\": \"triggered_only_unspecified\"\n", " },\n", " \"logs_threshold\": {\n", " \"condition_type\": \"more_than_or_unspecified\",\n", " \"logs_filter\": {\n", " \"simple_filter\": {\n", " \"label_filters\": {\n", " \"application_name\": [],\n", " \"severities\": [],\n", " \"subsystem_name\": []\n", " }\n", " }\n", " },\n", " \"notification_payload_filter\": [],\n", " \"rules\": [\n", " {\n", " \"condition\": {\n", " \"threshold\": 1,\n", " \"time_window\": {\n", " \"logs_time_window_specific_value\": \"minutes_10\"\n", " }\n", " },\n", " \"override\": {\n", " \"priority\": \"p5_or_unspecified\"\n", " }\n", " }\n", " ]\n", " },\n", " \"name\": \"Alert 1738141279354\",\n", " \"notification_group\": {\n", " \"group_by_keys\": [],\n", " \"webhooks\": []\n", " },\n", " \"phantom_mode\": false,\n", " \"priority\": \"p5_or_unspecified\",\n", " \"type\": \"logs_threshold\"\n", " }' \\\n", " \"${base_url}/v1/alert_definitions\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisAlertDefinitionTimeOfDayModel := &logsv0.ApisAlertDefinitionTimeOfDay{\n", " Hours: core.Int64Ptr(int64(22)),\n", "}\n", "\n", "apisAlertDefinitionActivityScheduleModel := &logsv0.ApisAlertDefinitionActivitySchedule{\n", " DayOfWeek: []string{\"sunday\", \"monday_or_unspecified\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\"},\n", " StartTime: apisAlertDefinitionTimeOfDayModel,\n", " EndTime: apisAlertDefinitionTimeOfDayModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefIncidentSettingsModel := &logsv0.ApisAlertDefinitionAlertDefIncidentSettings{\n", " NotifyOn: core.StringPtr(\"triggered_only_unspecified\"),\n", " Minutes: core.Int64Ptr(int64(10)),\n", "}\n", "\n", "apisAlertDefinitionIntegrationTypeModel := &logsv0.ApisAlertDefinitionIntegrationTypeIntegrationTypeIntegrationID{\n", "}\n", "\n", "apisAlertDefinitionAlertDefWebhooksSettingsModel := &logsv0.ApisAlertDefinitionAlertDefWebhooksSettings{\n", " Integration: apisAlertDefinitionIntegrationTypeModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefNotificationGroupModel := &logsv0.ApisAlertDefinitionAlertDefNotificationGroup{\n", " GroupByKeys: []string{},\n", " Webhooks: []logsv0.ApisAlertDefinitionAlertDefWebhooksSettings{*apisAlertDefinitionAlertDefWebhooksSettingsModel},\n", "}\n", "\n", "apisAlertDefinitionLabelFilterTypeModel := &logsv0.ApisAlertDefinitionLabelFilterType{\n", " Operation: core.StringPtr(\"starts_with\"),\n", "}\n", "\n", "apisAlertDefinitionLabelFiltersModel := &logsv0.ApisAlertDefinitionLabelFilters{\n", " ApplicationName: []logsv0.ApisAlertDefinitionLabelFilterType{*apisAlertDefinitionLabelFilterTypeModel},\n", " SubsystemName: []logsv0.ApisAlertDefinitionLabelFilterType{*apisAlertDefinitionLabelFilterTypeModel},\n", " Severities: []string{},\n", "}\n", "\n", "apisAlertDefinitionLogsSimpleFilterModel := &logsv0.ApisAlertDefinitionLogsSimpleFilter{\n", " LabelFilters: apisAlertDefinitionLabelFiltersModel,\n", "}\n", "\n", "apisAlertDefinitionLogsFilterModel := &logsv0.ApisAlertDefinitionLogsFilter{\n", " SimpleFilter: apisAlertDefinitionLogsSimpleFilterModel,\n", "}\n", "\n", "apisAlertDefinitionLogsTimeWindowModel := &logsv0.ApisAlertDefinitionLogsTimeWindow{\n", " LogsTimeWindowSpecificValue: core.StringPtr(\"minutes_10\"),\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdConditionModel := &logsv0.ApisAlertDefinitionLogsThresholdCondition{\n", " Threshold: core.Float64Ptr(float64(1)),\n", " TimeWindow: apisAlertDefinitionLogsTimeWindowModel,\n", "}\n", "\n", "apisAlertDefinitionAlertDefOverrideModel := &logsv0.ApisAlertDefinitionAlertDefOverride{\n", " Priority: core.StringPtr(\"p5_or_unspecified\"),\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdRuleModel := &logsv0.ApisAlertDefinitionLogsThresholdRule{\n", " Condition: apisAlertDefinitionLogsThresholdConditionModel,\n", " Override: apisAlertDefinitionAlertDefOverrideModel,\n", "}\n", "\n", "apisAlertDefinitionLogsThresholdTypeModel := &logsv0.ApisAlertDefinitionLogsThresholdType{\n", " LogsFilter: apisAlertDefinitionLogsFilterModel,\n", " Rules: []logsv0.ApisAlertDefinitionLogsThresholdRule{*apisAlertDefinitionLogsThresholdRuleModel},\n", " ConditionType: core.StringPtr(\"more_than_or_unspecified\"),\n", " NotificationPayloadFilter: []string{},\n", "}\n", "\n", "alertDefinitionPrototypeModel := &logsv0.AlertDefinitionPrototypeApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsThreshold{\n", " Name: core.StringPtr(\"Alert 1738141279354\"),\n", " Description: core.StringPtr(\"Example Alert definition\"),\n", " Enabled: core.BoolPtr(true),\n", " Priority: core.StringPtr(\"p5_or_unspecified\"),\n", " ActiveOn: apisAlertDefinitionActivityScheduleModel,\n", " Type: core.StringPtr(\"logs_threshold\"),\n", " GroupByKeys: []string{},\n", " IncidentsSettings: apisAlertDefinitionAlertDefIncidentSettingsModel,\n", " NotificationGroup: apisAlertDefinitionAlertDefNotificationGroupModel,\n", " PhantomMode: core.BoolPtr(false),\n", " Deleted: core.BoolPtr(false),\n", " LogsThreshold: apisAlertDefinitionLogsThresholdTypeModel,\n", "}\n", "\n", "createAlertDefOptions := logsService.NewCreateAlertDefOptions(\n", " alertDefinitionPrototypeModel,\n", ")\n", "\n", "alertDefinition, response, err := logsService.CreateAlertDef(createAlertDefOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alertDefinition, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/alerts/{id}": { "get": { "tags": [ "Alerts" ], "summary": "Get an alert by ID", "description": "Get an alert by ID.", "operationId": "get_alert", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{Name:name,ID:id,Is_Active:is_active,Severity:severity}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/alerts/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getAlertOptions := logsService.NewGetAlertOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "alert, response, err := logsService.GetAlert(getAlertOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alert, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Alerts" ], "summary": "Update an alert", "description": "Update an alert.", "operationId": "update_alert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertPrototype" }, "example": { "active_when": { "timeframes": [ { "days_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "range": { "end": { "hours": 18, "minutes": 29, "seconds": 59 }, "start": { "hours": 18, "minutes": 30, "seconds": 0 } } } ] }, "condition": { "more_than": { "evaluation_window": "rolling_or_unspecified", "parameters": { "cardinality_fields": [], "group_by": [ "coralogix.metadata.applicationName" ], "ignore_infinity": true, "notify_group_by_only_alerts": true, "relative_timeframe": "hour_or_unspecified", "threshold": 1, "timeframe": "timeframe_10_min" } } }, "description": "Alert when the number of logs reaches a threshold.", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "ratio_alerts": [], "severities": [ "info" ], "text": "initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create" }, "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 300, "use_as_notification_settings": true }, "is_active": true, "meta_labels": [ { "key": "env", "value": "dev" } ], "meta_labels_strings": [], "name": "Test alert", "notification_groups": [ { "group_by_fields": [ "coralogix.metadata.applicationName" ], "notifications": [] } ], "severity": "info_or_unspecified" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "AlertPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Is_Active:is_active,Severity:severity}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"active_when\": {\n", " \"timeframes\": [\n", " {\n", " \"days_of_week\": [\n", " \"sunday\",\n", " \"monday_or_unspecified\",\n", " \"tuesday\",\n", " \"wednesday\",\n", " \"thursday\",\n", " \"friday\",\n", " \"saturday\"\n", " ],\n", " \"range\": {\n", " \"end\": {\n", " \"hours\": 18,\n", " \"minutes\": 29,\n", " \"seconds\": 59\n", " },\n", " \"start\": {\n", " \"hours\": 18,\n", " \"minutes\": 30,\n", " \"seconds\": 0\n", " }\n", " }\n", " }\n", " ]\n", " },\n", " \"condition\": {\n", " \"more_than\": {\n", " \"evaluation_window\": \"rolling_or_unspecified\",\n", " \"parameters\": {\n", " \"cardinality_fields\": [],\n", " \"group_by\": [\n", " \"coralogix.metadata.applicationName\"\n", " ],\n", " \"ignore_infinity\": true,\n", " \"notify_group_by_only_alerts\": true,\n", " \"relative_timeframe\": \"hour_or_unspecified\",\n", " \"threshold\": 1,\n", " \"timeframe\": \"timeframe_10_min\"\n", " }\n", " }\n", " },\n", " \"description\": \"Alert when the number of logs reaches a threshold.\",\n", " \"filters\": {\n", " \"filter_type\": \"text_or_unspecified\",\n", " \"metadata\": {},\n", " \"ratio_alerts\": [],\n", " \"severities\": [\n", " \"info\"\n", " ],\n", " \"text\": \"initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create\"\n", " },\n", " \"incident_settings\": {\n", " \"notify_on\": \"triggered_only\",\n", " \"retriggering_period_seconds\": 300,\n", " \"use_as_notification_settings\": true\n", " },\n", " \"is_active\": true,\n", " \"meta_labels\": [\n", " {\n", " \"key\": \"env\",\n", " \"value\": \"dev\"\n", " }\n", " ],\n", " \"meta_labels_strings\": [],\n", " \"name\": \"Test alert\",\n", " \"notification_groups\": [\n", " {\n", " \"group_by_fields\": [\n", " \"coralogix.metadata.applicationName\"\n", " ],\n", " \"notifications\": []\n", " }\n", " ],\n", " \"severity\": \"info_or_unspecified\"\n", " }' \\\n", " \"${base_url}/v1/alerts/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "alertsV2ConditionParametersModel := &logsv0.AlertsV2ConditionParameters{\n", " Threshold: core.Float64Ptr(float64(1)),\n", " Timeframe: core.StringPtr(\"timeframe_10_min\"),\n", " GroupBy: []string{\"coralogix.metadata.applicationName\"},\n", " IgnoreInfinity: core.BoolPtr(true),\n", " RelativeTimeframe: core.StringPtr(\"hour_or_unspecified\"),\n", " CardinalityFields: []string{},\n", "}\n", "\n", "alertsV2MoreThanConditionModel := &logsv0.AlertsV2MoreThanCondition{\n", " Parameters: alertsV2ConditionParametersModel,\n", " EvaluationWindow: core.StringPtr(\"rolling_or_unspecified\"),\n", "}\n", "\n", "alertsV2AlertConditionModel := &logsv0.AlertsV2AlertConditionConditionMoreThan{\n", " MoreThan: alertsV2MoreThanConditionModel,\n", "}\n", "\n", "alertsV2AlertNotificationModel := &logsv0.AlertsV2AlertNotificationIntegrationTypeIntegrationID{\n", "}\n", "\n", "alertsV2AlertNotificationGroupsModel := &logsv0.AlertsV2AlertNotificationGroups{\n", " GroupByFields: []string{\"coralogix.metadata.applicationName\"},\n", " Notifications: []logsv0.AlertsV2AlertNotificationIntf{alertsV2AlertNotificationModel},\n", "}\n", "\n", "alertsV1AlertFiltersMetadataFiltersModel := &logsv0.AlertsV1AlertFiltersMetadataFilters{\n", "}\n", "\n", "alertsV1AlertFiltersRatioAlertModel := &logsv0.AlertsV1AlertFiltersRatioAlert{\n", " Alias: core.StringPtr(\"TopLevelAlert\"),\n", "}\n", "\n", "alertsV1AlertFiltersModel := &logsv0.AlertsV1AlertFilters{\n", " Severities: []string{\"info\"},\n", " Metadata: alertsV1AlertFiltersMetadataFiltersModel,\n", " Text: core.StringPtr(\"initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create\"),\n", " RatioAlerts: []logsv0.AlertsV1AlertFiltersRatioAlert{*alertsV1AlertFiltersRatioAlertModel},\n", " FilterType: core.StringPtr(\"text_or_unspecified\"),\n", "}\n", "\n", "alertsV1TimeModel := &logsv0.AlertsV1Time{\n", " Hours: core.Int64Ptr(int64(18)),\n", " Minutes: core.Int64Ptr(int64(30)),\n", " Seconds: core.Int64Ptr(int64(0)),\n", "}\n", "\n", "alertsV1TimeRangeModel := &logsv0.AlertsV1TimeRange{\n", " Start: alertsV1TimeModel,\n", " End: alertsV1TimeModel,\n", "}\n", "\n", "alertsV1AlertActiveTimeframeModel := &logsv0.AlertsV1AlertActiveTimeframe{\n", " DaysOfWeek: []string{\"sunday\", \"monday_or_unspecified\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\"},\n", " Range: alertsV1TimeRangeModel,\n", "}\n", "\n", "alertsV1AlertActiveWhenModel := &logsv0.AlertsV1AlertActiveWhen{\n", " Timeframes: []logsv0.AlertsV1AlertActiveTimeframe{*alertsV1AlertActiveTimeframeModel},\n", "}\n", "\n", "alertsV1MetaLabelModel := &logsv0.AlertsV1MetaLabel{\n", " Key: core.StringPtr(\"env\"),\n", " Value: core.StringPtr(\"dev\"),\n", "}\n", "\n", "alertsV2AlertIncidentSettingsModel := &logsv0.AlertsV2AlertIncidentSettings{\n", " RetriggeringPeriodSeconds: core.Int64Ptr(int64(300)),\n", " NotifyOn: core.StringPtr(\"triggered_only\"),\n", " UseAsNotificationSettings: core.BoolPtr(true),\n", "}\n", "\n", "updateAlertOptions := logsService.NewUpdateAlertOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " \"Test alert\",\n", " true,\n", " \"info_or_unspecified\",\n", " alertsV2AlertConditionModel,\n", ")\n", "updateAlertOptions.SetDescription(\"Alert when the number of logs reaches a threshold.\")\n", "updateAlertOptions.SetNotificationGroups([]logsv0.AlertsV2AlertNotificationGroups{*alertsV2AlertNotificationGroupsModel})\n", "updateAlertOptions.SetFilters(alertsV1AlertFiltersModel)\n", "updateAlertOptions.SetActiveWhen(alertsV1AlertActiveWhenModel)\n", "updateAlertOptions.SetMetaLabels([]logsv0.AlertsV1MetaLabel{*alertsV1MetaLabelModel})\n", "updateAlertOptions.SetMetaLabelsStrings([]string{})\n", "updateAlertOptions.SetIncidentSettings(alertsV2AlertIncidentSettingsModel)\n", "\n", "alert, response, err := logsService.UpdateAlert(updateAlertOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alert, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Alerts" ], "summary": "Delete an alert", "description": "Delete an alert", "operationId": "delete_alert", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/alerts/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteAlertOptions := logsService.NewDeleteAlertOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeleteAlert(deleteAlertOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteAlert(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "Alert ID", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Alert ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/AlertID" } ] }, "/v1/alerts": { "get": { "tags": [ "Alerts" ], "summary": "List alerts", "description": "List alerts", "operationId": "get_alerts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "alerts[*].{Name:name,ID:id,Is_Active:is_active,Severity:severity}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/alerts\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getAlertsOptions := logsService.NewGetAlertsOptions()\n", "\n", "alertCollection, response, err := logsService.GetAlerts(getAlertsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alertCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Alerts" ], "summary": "Create an alert", "description": "Create an alert", "operationId": "create_alert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertPrototype" }, "example": { "active_when": { "timeframes": [ { "days_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "range": { "end": { "hours": 18, "minutes": 29, "seconds": 59 }, "start": { "hours": 18, "minutes": 30, "seconds": 0 } } } ] }, "condition": { "more_than": { "evaluation_window": "rolling_or_unspecified", "parameters": { "cardinality_fields": [], "group_by": [ "coralogix.metadata.applicationName" ], "ignore_infinity": true, "notify_group_by_only_alerts": true, "relative_timeframe": "hour_or_unspecified", "threshold": 1, "timeframe": "timeframe_10_min" } } }, "description": "Alert when the number of logs reaches a threshold", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "ratio_alerts": [], "severities": [ "info" ], "text": "initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create" }, "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 300, "use_as_notification_settings": true }, "is_active": true, "meta_labels": [ { "key": "env", "value": "dev" } ], "meta_labels_strings": [], "name": "Test alert", "notification_groups": [ { "group_by_fields": [ "coralogix.metadata.applicationName" ], "notifications": [] } ], "severity": "info_or_unspecified" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Alert" } } }, "links": { "AlertID": { "$ref": "#/components/links/AlertID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "AlertPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Is_Active:is_active,Severity:severity}", "x-ibm-permissions": { "actions": [ { "name": "logs.alert-config.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.alert-config.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"active_when\": {\n", " \"timeframes\": [\n", " {\n", " \"days_of_week\": [\n", " \"sunday\",\n", " \"monday_or_unspecified\",\n", " \"tuesday\",\n", " \"wednesday\",\n", " \"thursday\",\n", " \"friday\",\n", " \"saturday\"\n", " ],\n", " \"range\": {\n", " \"end\": {\n", " \"hours\": 18,\n", " \"minutes\": 29,\n", " \"seconds\": 59\n", " },\n", " \"start\": {\n", " \"hours\": 18,\n", " \"minutes\": 30,\n", " \"seconds\": 0\n", " }\n", " }\n", " }\n", " ]\n", " },\n", " \"condition\": {\n", " \"more_than\": {\n", " \"evaluation_window\": \"rolling_or_unspecified\",\n", " \"parameters\": {\n", " \"cardinality_fields\": [],\n", " \"group_by\": [\n", " \"coralogix.metadata.applicationName\"\n", " ],\n", " \"ignore_infinity\": true,\n", " \"notify_group_by_only_alerts\": true,\n", " \"relative_timeframe\": \"hour_or_unspecified\",\n", " \"threshold\": 1,\n", " \"timeframe\": \"timeframe_10_min\"\n", " }\n", " }\n", " },\n", " \"description\": \"Alert when the number of logs reaches a threshold\",\n", " \"filters\": {\n", " \"filter_type\": \"text_or_unspecified\",\n", " \"metadata\": {},\n", " \"ratio_alerts\": [],\n", " \"severities\": [\n", " \"info\"\n", " ],\n", " \"text\": \"initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create\"\n", " },\n", " \"incident_settings\": {\n", " \"notify_on\": \"triggered_only\",\n", " \"retriggering_period_seconds\": 300,\n", " \"use_as_notification_settings\": true\n", " },\n", " \"is_active\": true,\n", " \"meta_labels\": [\n", " {\n", " \"key\": \"env\",\n", " \"value\": \"dev\"\n", " }\n", " ],\n", " \"meta_labels_strings\": [],\n", " \"name\": \"Test alert\",\n", " \"notification_groups\": [\n", " {\n", " \"group_by_fields\": [\n", " \"coralogix.metadata.applicationName\"\n", " ],\n", " \"notifications\": []\n", " }\n", " ],\n", " \"severity\": \"info_or_unspecified\"\n", " }' \\\n", " \"${base_url}/v1/alerts\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "alertsV2ConditionParametersModel := &logsv0.AlertsV2ConditionParameters{\n", " Threshold: core.Float64Ptr(float64(1)),\n", " Timeframe: core.StringPtr(\"timeframe_10_min\"),\n", " GroupBy: []string{\"coralogix.metadata.applicationName\"},\n", " IgnoreInfinity: core.BoolPtr(true),\n", " RelativeTimeframe: core.StringPtr(\"hour_or_unspecified\"),\n", " CardinalityFields: []string{},\n", "}\n", "\n", "alertsV2MoreThanConditionModel := &logsv0.AlertsV2MoreThanCondition{\n", " Parameters: alertsV2ConditionParametersModel,\n", " EvaluationWindow: core.StringPtr(\"rolling_or_unspecified\"),\n", "}\n", "\n", "alertsV2AlertConditionModel := &logsv0.AlertsV2AlertConditionConditionMoreThan{\n", " MoreThan: alertsV2MoreThanConditionModel,\n", "}\n", "\n", "alertsV2AlertNotificationModel := &logsv0.AlertsV2AlertNotificationIntegrationTypeIntegrationID{\n", "}\n", "\n", "alertsV2AlertNotificationGroupsModel := &logsv0.AlertsV2AlertNotificationGroups{\n", " GroupByFields: []string{\"coralogix.metadata.applicationName\"},\n", " Notifications: []logsv0.AlertsV2AlertNotificationIntf{alertsV2AlertNotificationModel},\n", "}\n", "\n", "alertsV1AlertFiltersMetadataFiltersModel := &logsv0.AlertsV1AlertFiltersMetadataFilters{\n", "}\n", "\n", "alertsV1AlertFiltersRatioAlertModel := &logsv0.AlertsV1AlertFiltersRatioAlert{\n", " Alias: core.StringPtr(\"TopLevelAlert\"),\n", "}\n", "\n", "alertsV1AlertFiltersModel := &logsv0.AlertsV1AlertFilters{\n", " Severities: []string{\"info\"},\n", " Metadata: alertsV1AlertFiltersMetadataFiltersModel,\n", " Text: core.StringPtr(\"initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create\"),\n", " RatioAlerts: []logsv0.AlertsV1AlertFiltersRatioAlert{*alertsV1AlertFiltersRatioAlertModel},\n", " FilterType: core.StringPtr(\"text_or_unspecified\"),\n", "}\n", "\n", "alertsV1TimeModel := &logsv0.AlertsV1Time{\n", " Hours: core.Int64Ptr(int64(18)),\n", " Minutes: core.Int64Ptr(int64(30)),\n", " Seconds: core.Int64Ptr(int64(0)),\n", "}\n", "\n", "alertsV1TimeRangeModel := &logsv0.AlertsV1TimeRange{\n", " Start: alertsV1TimeModel,\n", " End: alertsV1TimeModel,\n", "}\n", "\n", "alertsV1AlertActiveTimeframeModel := &logsv0.AlertsV1AlertActiveTimeframe{\n", " DaysOfWeek: []string{\"sunday\", \"monday_or_unspecified\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\"},\n", " Range: alertsV1TimeRangeModel,\n", "}\n", "\n", "alertsV1AlertActiveWhenModel := &logsv0.AlertsV1AlertActiveWhen{\n", " Timeframes: []logsv0.AlertsV1AlertActiveTimeframe{*alertsV1AlertActiveTimeframeModel},\n", "}\n", "\n", "alertsV1MetaLabelModel := &logsv0.AlertsV1MetaLabel{\n", " Key: core.StringPtr(\"env\"),\n", " Value: core.StringPtr(\"dev\"),\n", "}\n", "\n", "alertsV2AlertIncidentSettingsModel := &logsv0.AlertsV2AlertIncidentSettings{\n", " RetriggeringPeriodSeconds: core.Int64Ptr(int64(300)),\n", " NotifyOn: core.StringPtr(\"triggered_only\"),\n", " UseAsNotificationSettings: core.BoolPtr(true),\n", "}\n", "\n", "createAlertOptions := logsService.NewCreateAlertOptions(\n", " \"Test alert\",\n", " true,\n", " \"info_or_unspecified\",\n", " alertsV2AlertConditionModel,\n", ")\n", "createAlertOptions.SetDescription(\"Alert when the number of logs reaches a threshold\")\n", "createAlertOptions.SetNotificationGroups([]logsv0.AlertsV2AlertNotificationGroups{*alertsV2AlertNotificationGroupsModel})\n", "createAlertOptions.SetFilters(alertsV1AlertFiltersModel)\n", "createAlertOptions.SetActiveWhen(alertsV1AlertActiveWhenModel)\n", "createAlertOptions.SetMetaLabels([]logsv0.AlertsV1MetaLabel{*alertsV1MetaLabelModel})\n", "createAlertOptions.SetMetaLabelsStrings([]string{})\n", "createAlertOptions.SetIncidentSettings(alertsV2AlertIncidentSettingsModel)\n", "\n", "alert, response, err := logsService.CreateAlert(createAlertOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(alert, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/background_query": { "post": { "tags": [ "Background Query (Asynchronous Archive Query)" ], "summary": "Submit a background query to be processed asynchronously.", "description": "Submits a query that runs in the background, allowing the client to continue without waiting for the results immediately.", "operationId": "submit_background_query", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundQueryPrototype" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundQuery" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "bgq-create" ], "x-cli-command": "background-query-create", "x-ibm-permissions": { "actions": [ { "name": "logs.legacy-archive-query.execute" } ] }, "x-ibm-events": { "events": [ { "name": "logs.archive-queries.submit" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{ \"query\": \"source logs | filter $d.apiVersion == 42\", \"syntax\": \"dataprime_utf8_base64\" }' \\\n", " \"${base_url}/v1/background_query\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "submitBackgroundQueryOptions := logsService.NewSubmitBackgroundQueryOptions(\n", " \"source logs | filter $d.apiVersion == 42\",\n", " \"dataprime_utf8_base64\",\n", ")\n", "\n", "backgroundQuery, response, err := logsService.SubmitBackgroundQuery(submitBackgroundQueryOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(backgroundQuery, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/background_query/{query_id}/status": { "get": { "tags": [ "Background Query (Asynchronous Archive Query)" ], "summary": "Get the status of a background query", "description": "Get the status of a background query", "operationId": "get_background_query_status", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundQueryStatus" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "bgq-status" ], "x-cli-command": "background-query-status", "x-cli-table-filter-jmespath": "{SubmittedAt:submitted_at, Warnings:warnings, RunningSince:terminated.running_since, TerminatedAt:terminated.terminated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.legacy-archive-query.execute" } ] }, "x-ibm-events": { "events": [ { "name": "logs.archive-queries.status" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/background_query/${query_id}/status\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getBackgroundQueryStatusOptions := logsService.NewGetBackgroundQueryStatusOptions(\n", " CreateMockUUID(\"412036c3-04be-431a-b1e2-9ebf971be6c6\"),\n", ")\n", "\n", "backgroundQueryStatus, response, err := logsService.GetBackgroundQueryStatus(getBackgroundQueryStatusOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(backgroundQueryStatus, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "query_id", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "required": true, "schema": { "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "style": "simple" } ] }, "/v1/background_query/{query_id}/data": { "get": { "tags": [ "Background Query (Asynchronous Archive Query)" ], "summary": "Get the data of a background query", "description": "Retrieves the result of a previously submitted background query using its query ID.", "operationId": "get_background_query_data", "responses": { "200": { "description": "OK", "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryDataResponseStreamItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-sdk-exclude": false, "x-cli-command-aliases": [ "bgq-data" ], "x-cli-command": "background-query-data", "x-ibm-permissions": { "actions": [ { "name": "logs.legacy-archive-query.execute" } ] }, "x-ibm-events": { "events": [ { "name": "logs.archive-queries.get-data" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: text/event-stream\" \\\n", " \"${base_url}/v1/background_query/${query_id}/data\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getBackgroundQueryDataOptions := logsService.NewGetBackgroundQueryDataOptions(\n", " CreateMockUUID(\"412036c3-04be-431a-b1e2-9ebf971be6c6\"),\n", ")\n", "var (\n", " wg sync.WaitGroup\n", ")\n", "wg.Add(1)\n", "go func() {\n", " defer wg.Done()\n", " logsService.GetBackgroundQueryDataWithContext(context.Background(), getBackgroundQueryDataOptions, callBack{})\n", "}()\n", "\n", "wg.Wait()" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "query_id", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "required": true, "schema": { "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "style": "simple" } ] }, "/v1/background_query/{query_id}/cancel": { "post": { "tags": [ "Background Query (Asynchronous Archive Query)" ], "summary": "Cancel a background query", "description": "Cancel a background query", "operationId": "cancel_background_query", "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "bgq-cancel" ], "x-cli-command": "background-query-cancel", "x-ibm-permissions": { "actions": [ { "name": "logs.legacy-archive-query.execute" } ] }, "x-ibm-events": { "events": [ { "name": "logs.archive-queries.cancel" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/background_query/${query_id}/cancel\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "cancelBackgroundQueryOptions := logsService.NewCancelBackgroundQueryOptions(\n", " CreateMockUUID(\"412036c3-04be-431a-b1e2-9ebf971be6c6\"),\n", ")\n", "\n", "response, err := logsService.CancelBackgroundQuery(cancelBackgroundQueryOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 202 {\n", " fmt.Printf(\"\\nUnexpected response status code received from CancelBackgroundQuery(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "query_id", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "required": true, "schema": { "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "style": "simple" } ] }, "/v1/dashboards/{dashboard_id}": { "parameters": [ { "in": "path", "name": "dashboard_id", "description": "The ID of the dashboard", "required": true, "schema": { "description": "The ID of the dashboard", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple", "x-linkback": "#/components/links/DashboardID" } ] }, "/v1/dashboards/{dashboard_id}/pinned": { "parameters": [ { "in": "path", "name": "dashboard_id", "description": "The ID of the dashboard", "required": true, "schema": { "description": "The ID of the dashboard", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" } ] }, "/v1/dashboards/{dashboard_id}/default": { "parameters": [ { "in": "path", "name": "dashboard_id", "description": "The ID of the dashboard", "required": true, "schema": { "description": "The ID of the dashboard", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" } ] }, "/v1/dashboards/{dashboard_id}/folder/{folder_id}": { "parameters": [ { "in": "path", "name": "dashboard_id", "description": "The ID of the dashboard", "required": true, "schema": { "description": "The ID of the dashboard", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" }, { "in": "path", "name": "folder_id", "description": "The folder ID could be null to assign the dashboard to root", "required": true, "schema": { "description": "The folder ID could be null to assign the dashboard to root", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" } ] }, "/v1/data_access_rules": { "get": { "tags": [ "Data access rules" ], "summary": "Get service instance's Data Access Rules by ids", "description": "Get service instance's Data Access Rules by ids", "operationId": "list_data_access_rules", "parameters": [ { "in": "query", "name": "id", "description": "Array of data access rule IDs", "schema": { "example": [ "4f966911-4bda-407e-b069-477394effa59" ], "description": "Array of data access rule IDs", "type": "array", "items": { "description": "Array of data access rule IDs", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "minItems": 0, "maxItems": 4096 }, "example": [ "4f966911-4bda-407e-b069-477394effa59" ], "style": "deepObject" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessRuleCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "data_access_rules[*].{ID:id,Display_Name:display_name,Description:description}", "x-ibm-permissions": { "actions": [ { "name": "logs.data-access-rule.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.data-access-rule.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/data_access_rules?id=4f966911-4bda-407e-b069-477394effa59\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listDataAccessRulesOptions := logsService.NewListDataAccessRulesOptions()\n", "listDataAccessRulesOptions.SetID([]strfmt.UUID{\"4f966911-4bda-407e-b069-477394effa59\"})\n", "\n", "dataAccessRuleCollection, response, err := logsService.ListDataAccessRules(listDataAccessRulesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(dataAccessRuleCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Data access rules" ], "summary": "Create a data access rule", "description": "Create a data access rule", "operationId": "create_data_access_rule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessRulePrototype" }, "example": { "default_expression": "true", "description": "Data access rule intended for testing", "display_name": "Test data access rule", "filters": [ { "entity_type": "logs", "expression": " foo == 'bar'" } ] } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessRule" } } }, "links": { "DataAccessRulesID": { "$ref": "#/components/links/DataAccessRulesID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{ID:id,Description:description}", "x-ibm-permissions": { "actions": [ { "name": "logs.data-access-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "log.data-access-rule.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"default_expression\": \"true\",\n", " \"description\": \"Data access rule intended for testing\",\n", " \"display_name\": \"Test data access rule\",\n", " \"filters\": [\n", " {\n", " \"entity_type\": \"logs\",\n", " \"expression\": \" foo == bar\"\n", " }\n", " ]\n", " }' \\\n", " \"${base_url}/v1/data_access_rules\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "dataAccessRuleFilterModel := &logsv0.DataAccessRuleFilter{\n", " EntityType: core.StringPtr(\"logs\"),\n", " Expression: core.StringPtr(\" foo == 'bar'\"),\n", "}\n", "\n", "createDataAccessRuleOptions := logsService.NewCreateDataAccessRuleOptions(\n", " \"Test data access rule\",\n", " []logsv0.DataAccessRuleFilter{*dataAccessRuleFilterModel},\n", " \"true\",\n", ")\n", "createDataAccessRuleOptions.SetDescription(\"Data access rule intended for testing\")\n", "\n", "dataAccessRule, response, err := logsService.CreateDataAccessRule(createDataAccessRuleOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(dataAccessRule, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/data_access_rules/{id}": { "put": { "tags": [ "Data access rules" ], "summary": "Update a data access rule", "description": "Update a data access rule", "operationId": "update_data_access_rule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessRulePrototype" }, "example": { "default_expression": "true", "description": "Data access rule intended for testing", "display_name": "Test data access rule", "filters": [ { "entity_type": "logs", "expression": " foo == 'bar'" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAccessRule" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{ID:id,Description:description}", "x-ibm-permissions": { "actions": [ { "name": "logs.data-access-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.data-access-rule.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"default_expression\": \"true\",\n", " \"description\": \"Data access rule intended for testing\",\n", " \"display_name\": \"Test data access rule\",\n", " \"filters\": [\n", " {\n", " \"entity_type\": \"logs\",\n", " \"expression\": \" foo == bar\"\n", " }\n", " ]\n", " }' \\\n", " \"${base_url}/v1/data_access_rules/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "dataAccessRuleFilterModel := &logsv0.DataAccessRuleFilter{\n", " EntityType: core.StringPtr(\"logs\"),\n", " Expression: core.StringPtr(\" foo == 'bar'\"),\n", "}\n", "\n", "updateDataAccessRuleOptions := logsService.NewUpdateDataAccessRuleOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " \"Test data access rule\",\n", " []logsv0.DataAccessRuleFilter{*dataAccessRuleFilterModel},\n", " \"true\",\n", ")\n", "updateDataAccessRuleOptions.SetDescription(\"Data access rule intended for testing\")\n", "\n", "dataAccessRule, response, err := logsService.UpdateDataAccessRule(updateDataAccessRuleOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(dataAccessRule, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Data access rules" ], "summary": "Delete a data access rule", "description": "Delete a data access rule", "operationId": "delete_data_access_rule", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.data-access-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.data-access-rule.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/data_access_rules/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteDataAccessRuleOptions := logsService.NewDeleteDataAccessRuleOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeleteDataAccessRule(deleteDataAccessRuleOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteDataAccessRule(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "ID of the data access rule to be deleted", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "ID of the data access rule to be deleted", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/DataAccessRulesID" } ] }, "/v1/data_usage": { "get": { "tags": [ "Data usage" ], "summary": "Get data usage metrics export status or return data usage report", "description": "Get data usage metrics export status when invoked without query parameters.\nGet daily or detailed data usage report when invoked with query parameters.\n", "operationId": "export_data_usage", "parameters": [ { "in": "query", "name": "range", "description": "The range of days to retrieve data usage, by default it will use current month", "schema": { "$ref": "#/components/schemas/DatausageV1Range" }, "style": "deepObject" }, { "in": "query", "name": "query", "description": "Query to filter daily or detailed the data usage, by default it will use daily one", "schema": { "$ref": "#/components/schemas/DatausageV1Query" }, "style": "deepObject" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/DataUsageCollection" }, { "$ref": "#/components/schemas/DataUsageMetricsExportStatus" } ] }, "example": { "data_usages": [ { "application": "demo", "entity_type": "logs", "priority": "high", "severity": "info", "size": 3.5468562, "subsytem": "demo-logs", "timestamp": "2024-09-13T00:00:00.000Z" }, { "application": "demo", "entity_type": "logs", "priority": "high", "severity": "warning", "size": 1.575838, "subsytem": "demo-logs", "timestamp": "2024-09-13T00:00:00.000Z" }, { "priority": "high", "size": 0.079588555, "timestamp": "2024-09-13T00:00:00.000Z" }, { "application": "demo", "entity_type": "logs", "priority": "high", "severity": "error", "size": 0.31206962, "subsytem": "demo-logs", "timestamp": "2024-09-13T00:00:00.000Z" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "data-usage", "x-cli-table-filter-jmespath": "data_usages", "x-ibm-permissions": { "actions": [ { "name": "logs.data-usage.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.data-usage.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/data_usage?range=last_week&query=daily\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "exportDataUsageOptions := logsService.NewExportDataUsageOptions()\n", "exportDataUsageOptions.SetRange(\"last_week\")\n", "exportDataUsageOptions.SetQuery(\"daily\")\n", "\n", "exportDataUsageResponse, response, err := logsService.ExportDataUsage(exportDataUsageOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(exportDataUsageResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Data usage" ], "summary": "Update data usage metrics export status", "description": "Update data usage metrics export status", "operationId": "update_data_usage_metrics_export_status", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUsageMetricsExportStatus" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUsageMetricsExportStatus" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.data-usage.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.data-usage-to-metrics.enable" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"enabled\": true\n", " }' \\\n", " \"${base_url}/v1/data_usage\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "updateDataUsageMetricsExportStatusOptions := logsService.NewUpdateDataUsageMetricsExportStatusOptions(\n", " true,\n", ")\n", "\n", "dataUsageMetricsExportStatus, response, err := logsService.UpdateDataUsageMetricsExportStatus(updateDataUsageMetricsExportStatusOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(dataUsageMetricsExportStatus, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/enrichments": { "get": { "tags": [ "Enrichments" ], "summary": "List all enrichments", "description": "List all enrichments", "operationId": "get_enrichments", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichmentCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "enrichments[*].{ID:id,Field_Name:field_name}", "x-ibm-permissions": { "actions": [ { "name": "logs.geo-enrichment.read" }, { "name": "logs.custom-enrichment.read" }, { "name": "logs.security-enrichment.read" }, { "name": "logs.custom-enrichment-data.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.enrichment.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/enrichments\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getEnrichmentsOptions := logsService.NewGetEnrichmentsOptions()\n", "\n", "enrichmentCollection, response, err := logsService.GetEnrichments(getEnrichmentsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(enrichmentCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Enrichments" ], "summary": "Create an enrichment", "description": "Create an enrichment", "operationId": "create_enrichment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichmentPrototype" }, "example": { "enrichment_type": { "geo_ip": {} }, "field_name": "ip" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enrichment" } } }, "links": { "EncrichmentsID": { "$ref": "#/components/links/EnrichmentsID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{,ID:id,Field_Name:field_name}", "x-ibm-permissions": { "actions": [ { "name": "logs.geo-enrichment.manage" }, { "name": "logs.custom-enrichment.manage" }, { "name": "logs.security-enrichment.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.geo-enrichment.create" }, { "name": "logs.custom-enrichment.create" }, { "name": "logs.security-enrichment.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"enrichment_type\": {\n", " \"geo_ip\": {}\n", " },\n", " \"field_name\": \"ip\"\n", " }' \\\n", " \"${base_url}/v1/enrichments\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "enrichmentV1GeoIpTypeEmptyModel := &logsv0.EnrichmentV1GeoIpTypeEmpty{\n", "}\n", "\n", "enrichmentV1EnrichmentTypeModel := &logsv0.EnrichmentV1EnrichmentTypeTypeGeoIp{\n", " GeoIp: enrichmentV1GeoIpTypeEmptyModel,\n", "}\n", "\n", "createEnrichmentOptions := logsService.NewCreateEnrichmentOptions(\n", " \"ip\",\n", " enrichmentV1EnrichmentTypeModel,\n", ")\n", "\n", "enrichment, response, err := logsService.CreateEnrichment(createEnrichmentOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(enrichment, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/enrichments/{id}": { "delete": { "tags": [ "Enrichments" ], "summary": "Delete enrichments", "description": "Delete enrichments", "operationId": "remove_enrichments", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "enrichment-delete", "x-ibm-permissions": { "actions": [ { "name": "logs.geo-enrichment.manage" }, { "name": "logs.custom-enrichment.manage" }, { "name": "logs.security-enrichment.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.geo-enrichment.delete" }, { "name": "logs.custom-enrichment.delete" }, { "name": "logs.security-enrichment.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/enrichments/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "removeEnrichmentsOptions := logsService.NewRemoveEnrichmentsOptions(\n", " int64(1),\n", ")\n", "\n", "response, err := logsService.RemoveEnrichments(removeEnrichmentsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from RemoveEnrichments(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "The enrichment ID", "required": true, "schema": { "example": 1, "description": "The enrichment ID", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "style": "simple", "x-linkback": "#/components/links/EnrichmentsID" } ] }, "/v1/events2metrics": { "get": { "tags": [ "Events to metrics" ], "summary": "Lists events to metrics definitions", "description": "Lists events to metrics definitions", "operationId": "list_e2m", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2MetricCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "e2m-list" ], "x-cli-command": "events2metrics-list", "x-cli-table-filter-jmespath": "events2metrics[*].{Name:name,ID:id,Create_Time:create_time,Update_Time:update_time,Type:type}", "x-ibm-permissions": { "actions": [ { "name": "logs.events2metrics.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.events2metrics.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/events2metrics\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listE2mOptions := logsService.NewListE2mOptions()\n", "\n", "event2MetricCollection, response, err := logsService.ListE2m(listE2mOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(event2MetricCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Events to metrics" ], "summary": "Creates events to metrics definitions", "description": "Creates events to metrics definitions", "operationId": "create_e2m", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2MetricPrototype" }, "example": { "description": "Test Events to Metrics", "logs_query": { "lucene": "logs" }, "name": "test em2", "permutations_limit": 1, "type": "logs2metrics" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2Metric" } } }, "links": { "Events2MetricsID": { "$ref": "#/components/links/Events2MetricsID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "Event2MetricPrototype", "x-cli-command-aliases": [ "e2m-create" ], "x-cli-command": "events2metrics-create", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Description:description,Create_Time:create_time,Update_Time:update_time,Type:type,Is_Internal:is_internal}", "x-ibm-permissions": { "actions": [ { "name": "logs.events2metrics.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.events2metrics.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"description\": \"Test Events to Metrics\",\n", " \"logs_query\": {\n", " \"lucene\": \"logs\"\n", " },\n", " \"name\": \"test em2\",\n", " \"permutations_limit\": 1,\n", " \"type\": \"logs2metrics\"\n", " }' \\\n", " \"${base_url}/v1/events2metrics\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisLogs2metricsV2LogsQueryModel := &logsv0.ApisLogs2metricsV2LogsQuery{\n", " Lucene: core.StringPtr(\"logs\"),\n", "}\n", "\n", "event2MetricPrototypeModel := &logsv0.Event2MetricPrototypeApisEvents2metricsV2E2mCreateParamsQueryLogsQuery{\n", " Name: core.StringPtr(\"test em2\"),\n", " Description: core.StringPtr(\"Test Events to Metrics\"),\n", " PermutationsLimit: core.Int64Ptr(int64(1)),\n", " Type: core.StringPtr(\"logs2metrics\"),\n", " LogsQuery: apisLogs2metricsV2LogsQueryModel,\n", "}\n", "\n", "createE2mOptions := logsService.NewCreateE2mOptions(\n", " event2MetricPrototypeModel,\n", ")\n", "\n", "event2Metric, response, err := logsService.CreateE2m(createE2mOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(event2Metric, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/events2metrics/{id}": { "get": { "tags": [ "Events to metrics" ], "summary": "Gets events to metrics definitions by ID", "description": "Gets events to metrics definitions by ID", "operationId": "get_e2m", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2Metric" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "e2m" ], "x-cli-command": "events2metrics", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Create_Time:create_time,Update_Time:update_time,Type:type}", "x-ibm-permissions": { "actions": [ { "name": "logs.events2metrics.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.events2metrics.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/events2metrics/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getE2mOptions := logsService.NewGetE2mOptions(\n", " \"d6a3658e-78d2-47d0-9b81-b2c551f01b09\",\n", ")\n", "\n", "event2Metric, response, err := logsService.GetE2m(getE2mOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(event2Metric, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Events to metrics" ], "summary": "Updates events to metrics definitions", "description": "Updates events to metrics definitions", "operationId": "replace_e2m", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2MetricPrototype" }, "example": { "description": "Test Events to Metrics updated", "logs_query": { "lucene": "logs" }, "name": "test em2", "permutations_limit": 1, "type": "logs2metrics" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event2Metric" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "Event2MetricPrototype", "x-cli-command-aliases": [ "e2m-update" ], "x-cli-command": "events2metrics-update", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Create_Time:create_time,Update_Time:update_time,Type:type,Is_Internal:is_internal}", "x-ibm-permissions": { "actions": [ { "name": "logs.events2metrics.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.events2metrics.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"description\": \"Test Events to Metrics updated\",\n", " \"logs_query\": {\n", " \"lucene\": \"logs\"\n", " },\n", " \"name\": \"test em2\",\n", " \"permutations_limit\": 1,\n", " \"type\": \"logs2metrics\"\n", " }' \\\n", " \"${base_url}/v1/events2metrics/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisLogs2metricsV2LogsQueryModel := &logsv0.ApisLogs2metricsV2LogsQuery{\n", " Lucene: core.StringPtr(\"logs\"),\n", "}\n", "\n", "event2MetricPrototypeModel := &logsv0.Event2MetricPrototypeApisEvents2metricsV2E2mCreateParamsQueryLogsQuery{\n", " Name: core.StringPtr(\"test em2\"),\n", " Description: core.StringPtr(\"Test Events to Metrics updated\"),\n", " PermutationsLimit: core.Int64Ptr(int64(1)),\n", " Type: core.StringPtr(\"logs2metrics\"),\n", " LogsQuery: apisLogs2metricsV2LogsQueryModel,\n", "}\n", "\n", "replaceE2mOptions := logsService.NewReplaceE2mOptions(\n", " \"d6a3658e-78d2-47d0-9b81-b2c551f01b09\",\n", " event2MetricPrototypeModel,\n", ")\n", "\n", "event2Metric, response, err := logsService.ReplaceE2m(replaceE2mOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(event2Metric, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Events to metrics" ], "summary": "Deletes events to metrics definitions by ID", "description": "Deletes events to metrics definitions by ID", "operationId": "delete_e2m", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command-aliases": [ "e2m-delete" ], "x-cli-command": "events2metrics-delete", "x-ibm-permissions": { "actions": [ { "name": "logs.events2metrics.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.events2metrics.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/events2metrics/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteE2mOptions := logsService.NewDeleteE2mOptions(\n", " \"d6a3658e-78d2-47d0-9b81-b2c551f01b09\",\n", ")\n", "\n", "response, err := logsService.DeleteE2m(deleteE2mOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteE2m(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "ID of Events to Metrics to be deleted", "required": true, "schema": { "example": "d6a3658e-78d2-47d0-9b81-b2c551f01b09", "description": "ID of Events to Metrics to be deleted", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "example": "d6a3658e-78d2-47d0-9b81-b2c551f01b09", "style": "simple", "x-linkback": "#/components/links/Events2MetricsID" } ] }, "/v1/extensions/{id}": { "get": { "tags": [ "Extensions" ], "summary": "Get an extension by ID", "description": "Get an extension by ID", "operationId": "get_extension", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Extension" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "extension", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Revisions:revisions[*].version}", "x-ibm-permissions": { "actions": [ { "name": "logs.extension-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.extension.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/extensions/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getExtensionOptions := logsService.NewGetExtensionOptions(\n", " \"testString\",\n", ")\n", "\n", "extension, response, err := logsService.GetExtension(getExtensionOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(extension, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "The unique identifier of the extension.", "required": true, "schema": { "description": "The unique identifier of the extension.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" } ] }, "/v1/extensions/{id}/deployment": { "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the extension.", "required": true, "schema": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "style": "simple" } ], "get": { "tags": [ "Extensions" ], "summary": "Get deployment details of an extension", "description": "Get deployment details of an extension using id of an extension", "operationId": "get_extension_deployment", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionDeployment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "extension-deployment", "x-cli-table-filter-jmespath": "{DeployedVersion:version}", "x-ibm-permissions": { "actions": [ { "name": "logs.extension-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.extension.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/extensions/${id}/deployment\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getExtensionDeploymentOptions := logsService.NewGetExtensionDeploymentOptions(\n", " \"testString\",\n", ")\n", "\n", "extensionDeployment, response, err := logsService.GetExtensionDeployment(getExtensionDeploymentOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(extensionDeployment, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Extensions" ], "summary": "Deploy or update deployment of an extension.", "description": "Deploy or update deployment of an extension using extension ID", "operationId": "update_extension_deployment", "requestBody": { "description": "Deployment payload for the extension. `version` and `item_ids` are required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionDeployment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionDeployment" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "extension-deployment-manage", "x-cli-table-filter-jmespath": "{Version:version,ItemIds:item_ids[*]}", "x-ibm-permissions": { "actions": [ { "name": "logs.extension.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.extension.update" }, { "name": "logs.extension.deploy" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"version\": \"1.0.0\",\n", " \"item_ids\": [\n", " \"b9a5500c-715e-4ead-9bbe-56fdefffbfcd\",\n", " \"17bf6c1d-7869-48ba-9c46-96721d5e2603\",\n", " \"2d38545a-417c-4143-acb9-02c721d6312d\",\n", " \"a686e964-c0dc-453a-a124-508f91883d0d\",\n", " \"4082355b-5e40-4964-8578-52eb0e2e4037\",\n", " \"66aa7da8-d36e-49ee-b357-3424a1d4c3de\"\n", " ],\n", " \"applications\": [\n", " \"ltest_0401\"\n", " ],\n", " \"subsystems\": [\n", " \"ltest_0401\"\n", " ]\n", " }' \\\n", " \"${base_url}/v1/extensions/${id}/deployment\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "updateExtensionDeploymentOptions := logsService.NewUpdateExtensionDeploymentOptions(\n", " \"testString\",\n", " \"testString\",\n", " []string{\"b9a5500c-715e-4ead-9bbe-56fdefffbfcd\"},\n", ")\n", "\n", "extensionDeployment, response, err := logsService.UpdateExtensionDeployment(updateExtensionDeploymentOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(extensionDeployment, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Extensions" ], "summary": "Delete deployment of an extension", "description": "Delete deployment of an extension using extension ID.", "operationId": "delete_extension_deployment", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UndeployExtensionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "extension-deployment-delete", "x-cli-table-filter-jmespath": "{FailedItem:failed_items.item_id,FailureReason:failed_items.reason}", "x-ibm-permissions": { "actions": [ { "name": "logs.extension.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.extension.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/extensions/${id}/deployment\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteExtensionDeploymentOptions := logsService.NewDeleteExtensionDeploymentOptions(\n", " \"testString\",\n", ")\n", "\n", "undeployExtensionResponse, response, err := logsService.DeleteExtensionDeployment(deleteExtensionDeploymentOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(undeployExtensionResponse, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/extensions": { "get": { "tags": [ "Extensions" ], "summary": "Get list of extensions", "description": "Get list of extensions", "operationId": "get_extensions", "parameters": [ { "in": "query", "name": "deployed", "description": "Optional deployment filter. If omitted, returns all extensions. If true, returns only deployed extensions. If false, returns only non-deployed extensions.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "extensions", "x-cli-table-filter-jmespath": "extensions[*].{Name:name,ID:id,Revisions:revisions[*].version,DeployedVersion:deployment.version}", "x-ibm-permissions": { "actions": [ { "name": "logs.extension-config.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.extensions.list" }, { "name": "logs.deployed-extensions.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/extensions\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getExtensionsOptions := logsService.NewGetExtensionsOptions()\n", "\n", "extensionCollection, response, err := logsService.GetExtensions(getExtensionsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(extensionCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/view_folders": { "get": { "tags": [ "Folders for views" ], "summary": "List view's folders", "description": "List view's folders", "operationId": "list_view_folders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolderCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "view_folders[*].{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view-folder.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/view_folders\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listViewFoldersOptions := logsService.NewListViewFoldersOptions()\n", "\n", "viewFolderCollection, response, err := logsService.ListViewFolders(listViewFoldersOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(viewFolderCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Folders for views" ], "summary": "Create view folder", "description": "Create view folder", "operationId": "create_view_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolderPrototype" }, "example": { "name": "My Folder" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolder" } } }, "links": { "ViewFolderID": { "$ref": "#/components/links/ViewFolderID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "ViewFolderPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view-folder.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"name\": \"My Folder\"\n", " }' \\\n", " \"${base_url}/v1/view_folders\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "createViewFolderOptions := logsService.NewCreateViewFolderOptions(\n", " \"My Folder\",\n", ")\n", "\n", "viewFolder, response, err := logsService.CreateViewFolder(createViewFolderOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(viewFolder, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/view_folders/{id}": { "get": { "tags": [ "Folders for views" ], "summary": "Get view folder", "description": "Get view folder", "operationId": "get_view_folder", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolder" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "view_folders[*].{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view-folder.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/view_folders/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getViewFolderOptions := logsService.NewGetViewFolderOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "viewFolder, response, err := logsService.GetViewFolder(getViewFolderOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(viewFolder, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Folders for views" ], "summary": "Replaces an existing view folder", "description": "Replaces an existing view folder", "operationId": "replace_view_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolderPrototype" }, "example": { "name": "My Folder" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewFolder" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "ViewFolderPrototype", "x-cli-command": "view-folder-update", "x-cli-table-filter-jmespath": "view_folders[*].{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view-folder.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"name\": \"My Folder\"\n", " }' \\\n", " \"${base_url}/v1/view_folders/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "replaceViewFolderOptions := logsService.NewReplaceViewFolderOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " \"My Folder\",\n", ")\n", "\n", "viewFolder, response, err := logsService.ReplaceViewFolder(replaceViewFolderOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(viewFolder, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Folders for views" ], "summary": "Deletes a view folder by ID", "description": "Deletes a view folder by ID", "operationId": "delete_view_folder", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view-folder.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/view_folders/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteViewFolderOptions := logsService.NewDeleteViewFolderOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeleteViewFolder(deleteViewFolderOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteViewFolder(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "Folder ID", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Folder ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/ViewFolderID" } ] }, "/v1/log_data_retention_tags": { "get": { "tags": [ "Log data retention tags" ], "summary": "Get log data retention tags", "description": "Get log data retention tags. Returns 404 if retention tags have not been activated.", "operationId": "get_log_data_retention_tags", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogDataRetentionTags" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found - Retention tags are not active. Use PUT to activate.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Retention tags are not active" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "log-data-retention-tags", "x-cli-table-filter-jmespath": "tags", "x-ibm-permissions": { "actions": [ { "name": "logs.archive-retention.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.retentions.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/log_data_retention_tags\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getLogDataRetentionTagsOptions := logsService.NewGetLogDataRetentionTagsOptions()\n", "\n", "logDataRetentionTags, response, err := logsService.GetLogDataRetentionTags(getLogDataRetentionTagsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(logDataRetentionTags, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Log data retention tags" ], "summary": "Update log data retention tags", "description": "Update log data retention tags. If retention tags have not been activated yet, the first successful PUT request will activate them. An archive bucket must be configured before retention tags can be activated.", "operationId": "update_log_data_retention_tags", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogDataRetentionTags" }, "example": { "tags": [ "Short", "Intermediate", "Long" ] } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict - Archive bucket is not configured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Archive bucket must be attached before configuring retention tags." } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "log-data-retention-tags-update", "x-ibm-permissions": { "actions": [ { "name": "logs.archive-retention.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.retentions.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"tags\": [\n", " \"Short\",\n", " \"Intermediate\",\n", " \"Long\"\n", " ]\n", " }' \\\n", " \"${base_url}/v1/log_data_retention_tags\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "updateLogDataRetentionTagsOptions := logsService.NewUpdateLogDataRetentionTagsOptions(\n", " []string{\"Short\", \"Intermediate\", \"Long\"},\n", ")\n", "\n", "response, err := logsService.UpdateLogDataRetentionTags(updateLogDataRetentionTagsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from UpdateLogDataRetentionTags(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } } }, "/v1/outgoing_webhooks": { "get": { "tags": [ "Outbound Integrations" ], "summary": "List Outbound Integrations.", "description": "List Outbound Integrations.", "operationId": "list_outgoing_webhooks", "parameters": [ { "in": "query", "name": "type", "description": "The type of the deployed outbound integrations to list.", "schema": { "$ref": "#/components/schemas/OutgoingWebhooksV1WebhookType" }, "style": "deepObject" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhookCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "outgoing_webhooks[*].{Name:name,ID:id,URL:url,Created_At:created_at,Updated_At:updated_at,External_ID:external_id}", "x-ibm-permissions": { "actions": [ { "name": "logs.webhook.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.webhook.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/outgoing_webhooks?type=ibm_event_notifications\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listOutgoingWebhooksOptions := logsService.NewListOutgoingWebhooksOptions()\n", "listOutgoingWebhooksOptions.SetType(\"ibm_event_notifications\")\n", "\n", "outgoingWebhookCollection, response, err := logsService.ListOutgoingWebhooks(listOutgoingWebhooksOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(outgoingWebhookCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Outbound Integrations" ], "summary": "Create an outbound integration.", "description": "Create an outbound integration.", "operationId": "create_outgoing_webhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhookPrototype" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhook" } } }, "links": { "OutgoingWebhookID": { "$ref": "#/components/links/OutgoingWebhookID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "OutgoingWebhookPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Type:type,URL:url,Endpoint_Type:ibm_event_notifications.endpoint_type,Created_At:created_at,Updated_At:updated_at,External_ID:external_id,Source_ID:ibm_event_notifications.source_id,Source_Name:ibm_event_notifications.source_name}", "x-ibm-permissions": { "actions": [ { "name": "logs.webhook.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.webhook.crete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"type\": \"ibm_event_notifications\",\n", " \"name\": \"Event Notifications Integration\"\n", " }' \\\n", " \"${base_url}/v1/outgoing_webhooks\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "outgoingWebhookPrototypeModel := &logsv0.OutgoingWebhookPrototypeOutgoingWebhooksV1OutgoingWebhookInputDataConfigIbmEventNotifications{\n", " Type: core.StringPtr(\"ibm_event_notifications\"),\n", " Name: core.StringPtr(\"Event Notifications Integration\"),\n", "}\n", "\n", "createOutgoingWebhookOptions := logsService.NewCreateOutgoingWebhookOptions(\n", " outgoingWebhookPrototypeModel,\n", ")\n", "\n", "outgoingWebhook, response, err := logsService.CreateOutgoingWebhook(createOutgoingWebhookOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(outgoingWebhook, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/outgoing_webhooks/{id}": { "get": { "tags": [ "Outbound Integrations" ], "summary": "Gets an outbound integration by ID.", "description": "Gets an outbound integration by ID.", "operationId": "get_outgoing_webhook", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhook" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{Name:name,ID:id,Type:type,URL:url,Endpoint_Type:ibm_event_notifications.endpoint_type,Created_At:created_at,Updated_At:updated_at,External_ID:external_id,Source_ID:ibm_event_notifications.source_id,Source_Name:ibm_event_notifications.source_name}", "x-ibm-permissions": { "actions": [ { "name": "logs.webhook.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.webhook.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/outgoing_webhooks/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getOutgoingWebhookOptions := logsService.NewGetOutgoingWebhookOptions(\n", " CreateMockUUID(\"585bea36-bdd1-4bfb-9a26-51f1f8a12660\"),\n", ")\n", "\n", "outgoingWebhook, response, err := logsService.GetOutgoingWebhook(getOutgoingWebhookOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(outgoingWebhook, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Outbound Integrations" ], "summary": "Update an outbound integration.", "description": "Update an outbound integration.", "operationId": "update_outgoing_webhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhookPrototype" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhook" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "OutgoingWebhookPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Type:type,URL:url,Endpoint_Type:ibm_event_notifications.endpoint_type,Created_At:created_at,Updated_At:updated_at,External_ID:external_id,Source_ID:ibm_event_notifications.source_id,Source_Name:ibm_event_notifications.source_name}", "x-ibm-permissions": { "actions": [ { "name": "logs.webhook.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.webhook.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"type\": \"ibm_event_notifications\",\n", " \"name\": \"Event Notifications Integration\"\n", " }' \\\n", " \"${base_url}/v1/outgoing_webhooks/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "outgoingWebhookPrototypeModel := &logsv0.OutgoingWebhookPrototypeOutgoingWebhooksV1OutgoingWebhookInputDataConfigIbmEventNotifications{\n", " Type: core.StringPtr(\"ibm_event_notifications\"),\n", " Name: core.StringPtr(\"Event Notifications Integration\"),\n", "}\n", "\n", "updateOutgoingWebhookOptions := logsService.NewUpdateOutgoingWebhookOptions(\n", " CreateMockUUID(\"585bea36-bdd1-4bfb-9a26-51f1f8a12660\"),\n", " outgoingWebhookPrototypeModel,\n", ")\n", "\n", "outgoingWebhook, response, err := logsService.UpdateOutgoingWebhook(updateOutgoingWebhookOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(outgoingWebhook, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Outbound Integrations" ], "summary": "Delete an outbound integration.", "description": "Delete an outbound integration.", "operationId": "delete_outgoing_webhook", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.webhook.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.webhook.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/outgoing_webhooks/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteOutgoingWebhookOptions := logsService.NewDeleteOutgoingWebhookOptions(\n", " CreateMockUUID(\"585bea36-bdd1-4bfb-9a26-51f1f8a12660\"),\n", ")\n", "\n", "response, err := logsService.DeleteOutgoingWebhook(deleteOutgoingWebhookOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteOutgoingWebhook(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "The ID of the outbound integration to delete.", "required": true, "schema": { "example": "585bea36-bdd1-4bfb-9a26-51f1f8a12660", "description": "The ID of the outbound integration to delete.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "585bea36-bdd1-4bfb-9a26-51f1f8a12660", "style": "simple", "x-linkback": "#/components/links/OutgoingWebhookID" } ] }, "/v1/policies/{id}": { "get": { "tags": [ "Policies" ], "summary": "Gets policy by ID", "description": "Gets policy by ID", "operationId": "get_policy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Created_At:created_at,Updated_At:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-tco-policy.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-tco-policy.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/policies/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getPolicyOptions := logsService.NewGetPolicyOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "policy, response, err := logsService.GetPolicy(getPolicyOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(policy, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Policies" ], "summary": "Updates an existing policy", "description": "Updates an existing policy", "operationId": "update_policy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyPrototype" }, "example": { "application_rule": { "name": "policy-test", "rule_type_id": "is" }, "deleted": false, "description": "Medium policy", "enabled": true, "log_rules": { "severities": [ "debug", "verbose", "info", "warning", "error" ] }, "name": "Med_policy", "order": 2, "priority": "type_high", "subsystem_rule": { "name": "policy-test", "rule_type_id": "is" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "PolicyPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Created_At:created_at,Updated_At:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-tco-policy.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-tco-policy.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"application_rule\": {\n", " \"name\": \"policy-test\",\n", " \"rule_type_id\": \"is\"\n", " },\n", " \"deleted\": false,\n", " \"description\": \"Medium policy\",\n", " \"enabled\": true,\n", " \"log_rules\": {\n", " \"severities\": [\n", " \"debug\",\n", " \"verbose\",\n", " \"info\",\n", " \"warning\",\n", " \"error\"\n", " ]\n", " },\n", " \"name\": \"Med_policy\",\n", " \"order\": 2,\n", " \"priority\": \"type_high\",\n", " \"subsystem_rule\": {\n", " \"name\": \"policy-test\",\n", " \"rule_type_id\": \"is\"\n", " }\n", " }' \\\n", " \"${base_url}/v1/policies/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "quotaV1RuleModel := &logsv0.QuotaV1Rule{\n", " RuleTypeID: core.StringPtr(\"is\"),\n", " Name: core.StringPtr(\"policy-test\"),\n", "}\n", "\n", "quotaV1LogRulesModel := &logsv0.QuotaV1LogRules{\n", " Severities: []string{\"debug\", \"verbose\", \"info\", \"warning\", \"error\"},\n", "}\n", "\n", "policyPrototypeModel := &logsv0.PolicyPrototypeQuotaV1CreatePolicyRequestSourceTypeRulesLogRules{\n", " Name: core.StringPtr(\"Med_policy\"),\n", " Description: core.StringPtr(\"Medium policy\"),\n", " Priority: core.StringPtr(\"type_high\"),\n", " ApplicationRule: quotaV1RuleModel,\n", " SubsystemRule: quotaV1RuleModel,\n", " Enabled: core.BoolPtr(true),\n", " LogRules: quotaV1LogRulesModel,\n", "}\n", "\n", "updatePolicyOptions := logsService.NewUpdatePolicyOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " policyPrototypeModel,\n", ")\n", "\n", "policy, response, err := logsService.UpdatePolicy(updatePolicyOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(policy, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Policies" ], "summary": "Deletes an existing policy", "description": "Deletes an existing policy", "operationId": "delete_policy", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.logs-tco-policy.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-tco-policy.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/policies/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deletePolicyOptions := logsService.NewDeletePolicyOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeletePolicy(deletePolicyOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeletePolicy(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "ID of policy", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "ID of policy", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/PolicyID" } ] }, "/v1/policies": { "get": { "tags": [ "Policies" ], "summary": "Gets policies", "description": "Gets policies", "operationId": "get_company_policies", "parameters": [ { "in": "query", "name": "enabled_only", "description": "Optionally filter only enabled policies", "schema": { "example": true, "description": "Optionally filter only enabled policies", "type": "boolean" }, "style": "deepObject" }, { "in": "query", "name": "source_type", "description": "Source type used to filter policies", "schema": { "$ref": "#/components/schemas/QuotaV1SourceType" }, "style": "deepObject" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-command": "policies", "x-cli-table-filter-jmespath": "policies[*].{Name:name,ID:id,Enabled:enabled,Created_At:created_at,Updated_At:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-tco-policy.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-tco-policy.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/policies?enabled_only=true&source_type=logs\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getCompanyPoliciesOptions := logsService.NewGetCompanyPoliciesOptions()\n", "getCompanyPoliciesOptions.SetEnabledOnly(true)\n", "getCompanyPoliciesOptions.SetSourceType(\"logs\")\n", "\n", "policyCollection, response, err := logsService.GetCompanyPolicies(getCompanyPoliciesOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(policyCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Policies" ], "summary": "Creates a new policy", "description": "Creates a new policy", "operationId": "create_policy", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyPrototype" }, "example": { "application_rule": { "name": "policy-test", "rule_type_id": "is" }, "deleted": false, "description": "Medium Policy", "enabled": true, "log_rules": { "severities": [ "debug", "verbose", "info", "warning", "error" ] }, "name": "Med_policy", "order": 2, "priority": "type_high", "subsystem_rule": { "name": "policy-test", "rule_type_id": "is" } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policy" } } }, "links": { "PolicyID": { "$ref": "#/components/links/PolicyID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "PolicyPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled,Created_At:created_at,Updated_At:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-tco-policy.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-tco-policy.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"application_rule\": {\n", " \"name\": \"policy-test\",\n", " \"rule_type_id\": \"is\"\n", " },\n", " \"deleted\": false,\n", " \"description\": \"Medium Policy\",\n", " \"enabled\": true,\n", " \"log_rules\": {\n", " \"severities\": [\n", " \"debug\",\n", " \"verbose\",\n", " \"info\",\n", " \"warning\",\n", " \"error\"\n", " ]\n", " },\n", " \"name\": \"Med_policy\",\n", " \"order\": 2,\n", " \"priority\": \"type_high\",\n", " \"subsystem_rule\": {\n", " \"name\": \"policy-test\",\n", " \"rule_type_id\": \"is\"\n", " }\n", " }' \\\n", " \"${base_url}/v1/policies\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "quotaV1RuleModel := &logsv0.QuotaV1Rule{\n", " RuleTypeID: core.StringPtr(\"is\"),\n", " Name: core.StringPtr(\"policy-test\"),\n", "}\n", "\n", "quotaV1LogRulesModel := &logsv0.QuotaV1LogRules{\n", " Severities: []string{\"debug\", \"verbose\", \"info\", \"warning\", \"error\"},\n", "}\n", "\n", "policyPrototypeModel := &logsv0.PolicyPrototypeQuotaV1CreatePolicyRequestSourceTypeRulesLogRules{\n", " Name: core.StringPtr(\"Med_policy\"),\n", " Description: core.StringPtr(\"Medium Policy\"),\n", " Priority: core.StringPtr(\"type_high\"),\n", " ApplicationRule: quotaV1RuleModel,\n", " SubsystemRule: quotaV1RuleModel,\n", " Enabled: core.BoolPtr(true),\n", " LogRules: quotaV1LogRulesModel,\n", "}\n", "\n", "createPolicyOptions := logsService.NewCreatePolicyOptions(\n", " policyPrototypeModel,\n", ")\n", "\n", "policy, response, err := logsService.CreatePolicy(createPolicyOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(policy, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/query": { "post": { "tags": [ "Query" ], "summary": "Run a query to search the logs", "description": "Run a query to search the logs. Note that this is a SSE (Server Sent Events) API and the content type of the response is text/event-stream", "operationId": "query", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryRequest" }, "example": { "metadata": { "end_date": "2024-05-02T22:47:12.940Z", "limit": 100, "start_date": "2024-05-01T20:47:12.940Z", "strict_fields_validation": false, "syntax": "dataprime", "tier": "frequent_search" }, "query": "source logs | limit 10" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/QueryResponseStreamItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-sdk-exclude": false, "x-ibm-permissions": { "actions": [ { "name": "logs.logs-data-api-high.read" }, { "name": "logs.logs-data-api-low.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-data.search" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: text/event-stream\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"metadata\": {\n", " \"end_date\": \"2024-05-02T22:47:12.940Z\",\n", " \"limit\": 100,\n", " \"start_date\": \"2024-05-01T20:47:12.940Z\",\n", " \"strict_fields_validation\": false,\n", " \"syntax\": \"dataprime\",\n", " \"tier\": \"frequent_search\"\n", " },\n", " \"query\": \"source logs | limit 10\"\n", " }' \\\n", " \"${base_url}/v1/query\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "query := \"source logs | limit 10\"\n", "queryOptions := logsv0.QueryOptions{\n", " Query: &query,\n", " Metadata: &logsv0.ApisDataprimeV1Metadata{\n", " StartDate: CreateDateTime(\"2024-03-01T20:47:12.940Z\"),\n", " EndDate: CreateDateTime(\"2024-03-06T20:47:12.940Z\"),\n", " Tier: core.StringPtr(\"frequent_search\"),\n", " Syntax: core.StringPtr(\"dataprime\"),\n", " },\n", "}\n", "var (\n", " wg sync.WaitGroup\n", ")\n", "\n", "// Define custom callback to collect results and errors\n", "\n", "wg.Add(1)\n", "go func() {\n", " defer wg.Done()\n", " logsService.QueryWithContext(context.Background(), &queryOptions, callBack{})\n", "}()\n", "\n", "wg.Wait()" ] } ] } ] } } } }, "/v1/rule_groups/{group_id}": { "get": { "tags": [ "Rules" ], "summary": "Gets rule group by groupid", "description": "Gets rule group by groupid", "operationId": "get_rule_group", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled}", "x-ibm-permissions": { "actions": [ { "name": "logs.parsing-rule.get" } ] }, "x-ibm-events": { "events": [ { "name": "logs.parsing-rule.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/rule_groups/${group_id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getRuleGroupOptions := logsService.NewGetRuleGroupOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "ruleGroup, response, err := logsService.GetRuleGroup(getRuleGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(ruleGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Rules" ], "summary": "Updates rule group by groupid", "description": "Updates rule group by groupid", "operationId": "update_rule_group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroupPrototype" }, "example": { "description": "mysql audit logs parser", "enabled": true, "hidden": false, "name": "mysql-extractrule", "order": 39, "rule_matchers": [ { "subsystem_name": { "value": "mysql" } } ], "rule_subgroups": [ { "enabled": true, "order": 1, "rules": [ { "description": "mysql-parse", "enabled": true, "name": "mysql-parse", "order": 1, "parameters": { "parse_parameters": { "destination_field": "text", "rule": "(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)" } }, "source_field": "text" } ] } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "RuleGroupPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled}", "x-ibm-permissions": { "actions": [ { "name": "logs.parsing-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.parsing-rule.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"description\": \"mysql audit logs parser\",\n", " \"enabled\": true,\n", " \"hidden\": false,\n", " \"name\": \"mysql-extractrule\",\n", " \"order\": 39,\n", " \"rule_matchers\": [\n", " {\n", " \"subsystem_name\": {\n", " \"value\": \"mysql\"\n", " }\n", " }\n", " ],\n", " \"rule_subgroups\": [\n", " {\n", " \"enabled\": true,\n", " \"order\": 1,\n", " \"rules\": [\n", " {\n", " \"description\": \"mysql-parse\",\n", " \"enabled\": true,\n", " \"name\": \"mysql-parse\",\n", " \"order\": 1,\n", " \"parameters\": {\n", " \"parse_parameters\": {\n", " \"destination_field\": \"text\",\n", " \"rule\": \"(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),?(?P.*)?,(?P[0-9]+)\"\n", " }\n", " },\n", " \"source_field\": \"text\"\n", " }\n", " ]\n", " }\n", " ]\n", " }' \\\n", " \"${base_url}/v1/rule_groups/${group_id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "rulesV1ParseParametersModel := &logsv0.RulesV1ParseParameters{\n", " DestinationField: core.StringPtr(\"text\"),\n", " Rule: core.StringPtr(\"(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)\"),\n", "}\n", "\n", "rulesV1RuleParametersModel := &logsv0.RulesV1RuleParametersRuleParametersParseParameters{\n", " ParseParameters: rulesV1ParseParametersModel,\n", "}\n", "\n", "rulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRuleModel := &logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule{\n", " Name: core.StringPtr(\"mysql-parse\"),\n", " Description: core.StringPtr(\"mysql-parse\"),\n", " SourceField: core.StringPtr(\"text\"),\n", " Parameters: rulesV1RuleParametersModel,\n", " Enabled: core.BoolPtr(true),\n", " Order: core.Int64Ptr(int64(1)),\n", "}\n", "\n", "rulesV1CreateRuleGroupRequestCreateRuleSubgroupModel := &logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroup{\n", " Rules: []logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule{*rulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRuleModel},\n", " Enabled: core.BoolPtr(true),\n", " Order: core.Int64Ptr(int64(1)),\n", "}\n", "\n", "rulesV1SubsystemNameConstraintModel := &logsv0.RulesV1SubsystemNameConstraint{\n", " Value: core.StringPtr(\"mysql\"),\n", "}\n", "\n", "rulesV1RuleMatcherModel := &logsv0.RulesV1RuleMatcherConstraintSubsystemName{\n", " SubsystemName: rulesV1SubsystemNameConstraintModel,\n", "}\n", "\n", "updateRuleGroupOptions := logsService.NewUpdateRuleGroupOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", " \"mysql-extractrule\",\n", " []logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroup{*rulesV1CreateRuleGroupRequestCreateRuleSubgroupModel},\n", ")\n", "updateRuleGroupOptions.SetDescription(\"mysql audit logs parser\")\n", "updateRuleGroupOptions.SetEnabled(true)\n", "updateRuleGroupOptions.SetRuleMatchers([]logsv0.RulesV1RuleMatcherIntf{rulesV1RuleMatcherModel})\n", "updateRuleGroupOptions.SetOrder(int64(39))\n", "\n", "ruleGroup, response, err := logsService.UpdateRuleGroup(updateRuleGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(ruleGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Rules" ], "summary": "Deletes rule group by groupid", "description": "Deletes rule group by groupid", "operationId": "delete_rule_group", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.parsing-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.parsing-rule.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/rule_groups/${group_id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteRuleGroupOptions := logsService.NewDeleteRuleGroupOptions(\n", " CreateMockUUID(\"3dc02998-0b50-4ea8-b68a-4779d716fa1f\"),\n", ")\n", "\n", "response, err := logsService.DeleteRuleGroup(deleteRuleGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteRuleGroup(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "group_id", "description": "The group ID", "required": true, "schema": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The group ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "style": "simple", "x-linkback": "#/components/links/RuleGroupID" } ] }, "/v1/rule_groups": { "get": { "tags": [ "Rules" ], "summary": "Gets all rule groups", "description": "Gets all rule groups", "operationId": "list_rule_groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroupCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "rulegroups[*].{Name:name,ID:id,Enabled:enabled}", "x-ibm-permissions": { "actions": [ { "name": "logs.parsing-rule.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.parsing-rule.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/rule_groups\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listRuleGroupsOptions := logsService.NewListRuleGroupsOptions()\n", "\n", "ruleGroupCollection, response, err := logsService.ListRuleGroups(listRuleGroupsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(ruleGroupCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Rules" ], "summary": "Creates rule group", "description": "Creates rule group", "operationId": "create_rule_group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroupPrototype" }, "example": { "description": "mysql audit logs parser", "enabled": true, "hidden": false, "name": "mysql-extractrule", "order": 39, "rule_matchers": [ { "subsystem_name": { "value": "mysql" } } ], "rule_subgroups": [ { "enabled": true, "order": 1, "rules": [ { "description": "mysql-parse", "enabled": true, "name": "mysql-parse", "order": 1, "parameters": { "parse_parameters": { "destination_field": "text", "rule": "(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)" } }, "source_field": "text" } ] } ] } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleGroup" } } }, "links": { "RuleGroupID": { "$ref": "#/components/links/RuleGroupID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "RuleGroupPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id,Enabled:enabled}", "x-ibm-permissions": { "actions": [ { "name": "logs.parsing-rule.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.parsing-rule.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"description\": \"mysql audit logs parser\",\n", " \"enabled\": true,\n", " \"hidden\": false,\n", " \"name\": \"mysql-extractrule\",\n", " \"order\": 39,\n", " \"rule_matchers\": [\n", " {\n", " \"subsystem_name\": {\n", " \"value\": \"mysql\"\n", " }\n", " }\n", " ],\n", " \"rule_subgroups\": [\n", " {\n", " \"enabled\": true,\n", " \"order\": 1,\n", " \"rules\": [\n", " {\n", " \"description\": \"mysql-parse\",\n", " \"enabled\": true,\n", " \"name\": \"mysql-parse\",\n", " \"order\": 1,\n", " \"parameters\": {\n", " \"parse_parameters\": {\n", " \"destination_field\": \"text\",\n", " \"rule\": \"(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),?(?P.*)?,(?P[0-9]+)\"\n", " }\n", " },\n", " \"source_field\": \"text\"\n", " }\n", " ]\n", " }\n", " ]\n", " }' \\\n", " \"${base_url}/v1/rule_groups\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "rulesV1ParseParametersModel := &logsv0.RulesV1ParseParameters{\n", " DestinationField: core.StringPtr(\"text\"),\n", " Rule: core.StringPtr(\"(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)\"),\n", "}\n", "\n", "rulesV1RuleParametersModel := &logsv0.RulesV1RuleParametersRuleParametersParseParameters{\n", " ParseParameters: rulesV1ParseParametersModel,\n", "}\n", "\n", "rulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRuleModel := &logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule{\n", " Name: core.StringPtr(\"mysql-parse\"),\n", " Description: core.StringPtr(\"mysql-parse\"),\n", " SourceField: core.StringPtr(\"text\"),\n", " Parameters: rulesV1RuleParametersModel,\n", " Enabled: core.BoolPtr(true),\n", " Order: core.Int64Ptr(int64(1)),\n", "}\n", "\n", "rulesV1CreateRuleGroupRequestCreateRuleSubgroupModel := &logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroup{\n", " Rules: []logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule{*rulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRuleModel},\n", " Enabled: core.BoolPtr(true),\n", " Order: core.Int64Ptr(int64(1)),\n", "}\n", "\n", "rulesV1SubsystemNameConstraintModel := &logsv0.RulesV1SubsystemNameConstraint{\n", " Value: core.StringPtr(\"mysql\"),\n", "}\n", "\n", "rulesV1RuleMatcherModel := &logsv0.RulesV1RuleMatcherConstraintSubsystemName{\n", " SubsystemName: rulesV1SubsystemNameConstraintModel,\n", "}\n", "\n", "createRuleGroupOptions := logsService.NewCreateRuleGroupOptions(\n", " \"mysql-extractrule\",\n", " []logsv0.RulesV1CreateRuleGroupRequestCreateRuleSubgroup{*rulesV1CreateRuleGroupRequestCreateRuleSubgroupModel},\n", ")\n", "createRuleGroupOptions.SetDescription(\"mysql audit logs parser\")\n", "createRuleGroupOptions.SetEnabled(true)\n", "createRuleGroupOptions.SetRuleMatchers([]logsv0.RulesV1RuleMatcherIntf{rulesV1RuleMatcherModel})\n", "createRuleGroupOptions.SetOrder(int64(39))\n", "\n", "ruleGroup, response, err := logsService.CreateRuleGroup(createRuleGroupOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(ruleGroup, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/streams": { "get": { "tags": [ "Streams" ], "summary": "List all Event Streams.", "description": "List all Event Streams.", "operationId": "get_event_stream_targets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "streams[*].{Name:name, ID:id, Status:is_active, Brokers:ibm_event_streams.brokers, DpxlExpression:dpxl_expression, Topic:ibm_event_streams.topic, Compression:compression_type, CreatedAt:created_at, UpdatedAt:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-stream-setup.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-stream-setup.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/streams\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getEventStreamTargetsOptions := logsService.NewGetEventStreamTargetsOptions()\n", "\n", "streamCollection, response, err := logsService.GetEventStreamTargets(getEventStreamTargetsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(streamCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Streams" ], "summary": "Create an Event Stream Integration.", "description": "Create an Event Stream Integration.", "operationId": "create_event_stream_target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPrototype" }, "example": { "compression_type": "gzip", "dpxl_expression": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "ibm_event_streams": { "brokers": "kafka01.example.com:9093", "topic": "live.screen" }, "name": "Live Screen" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stream" } } }, "links": { "StreamID": { "$ref": "#/components/links/StreamID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "StreamPrototype", "x-cli-table-filter-jmespath": "{Name:name, ID:id, Status:is_active, Brokers:ibm_event_streams.brokers, DpxlExpression:dpxl_expression, Topic:ibm_event_streams.topic, Compression:compression_type, CreatedAt:created_at, UpdatedAt:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-stream-setup.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-stream-setup.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"compression_type\": \"gzip\",\n", " \"dpxl_expression\": \"contains(kubernetes.labels.CX_AZ, eu-west-1)\",\n", " \"ibm_event_streams\": {\n", " \"brokers\": \"kafka01.example.com:9093\",\n", " \"topic\": \"live.screen\"\n", " },\n", " \"name\": \"Live Screen\"\n", " }' \\\n", " \"${base_url}/v1/streams\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmEventStreamsModel := &logsv0.IbmEventStreams{\n", " Brokers: core.StringPtr(\"kafka01.example.com:9093\"),\n", " Topic: core.StringPtr(\"live.screen\"),\n", "}\n", "\n", "createEventStreamTargetOptions := logsService.NewCreateEventStreamTargetOptions(\n", " \"Live Screen\",\n", " \"contains(kubernetes.labels.CX_AZ, 'eu-west-1')\",\n", ")\n", "createEventStreamTargetOptions.SetCompressionType(\"gzip\")\n", "createEventStreamTargetOptions.SetIbmEventStreams(ibmEventStreamsModel)\n", "\n", "stream, response, err := logsService.CreateEventStreamTarget(createEventStreamTargetOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(stream, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/streams/{id}": { "put": { "tags": [ "Streams" ], "summary": "Update an Event Stream.", "description": "Update an Event Stream.", "operationId": "update_event_stream_target", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPrototype" }, "example": { "compression_type": "gzip", "dpxl_expression": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "ibm_event_streams": { "brokers": "kafka01.example.com:9093", "topic": "live.screen" }, "name": "Live Screen" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stream" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "Stream", "x-cli-table-filter-jmespath": "{Name:name, ID:id, Status:is_active, Brokers:ibm_event_streams.brokers, DpxlExpression:dpxl_expression, Topic:ibm_event_streams.topic, CompressionType:compression_type, CreatedAt:created_at, UpdatedAt:updated_at}", "x-ibm-permissions": { "actions": [ { "name": "logs.logs-stream-setup.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-stream-setup.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"compression_type\": \"gzip\",\n", " \"dpxl_expression\": \"contains(kubernetes.labels.CX_AZ, eu-west-1)\",\n", " \"ibm_event_streams\": {\n", " \"brokers\": \"kafka01.example.com:9093\",\n", " \"topic\": \"live.screen\"\n", " },\n", " \"name\": \"Live Screen\"\n", " }' \\\n", " \"${base_url}/v1/streams/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "ibmEventStreamsModel := &logsv0.IbmEventStreams{\n", " Brokers: core.StringPtr(\"kafka01.example.com:9093\"),\n", " Topic: core.StringPtr(\"live.screen\"),\n", "}\n", "\n", "updateEventStreamTargetOptions := logsService.NewUpdateEventStreamTargetOptions(\n", " int64(0),\n", " \"Live Screen\",\n", " \"contains(kubernetes.labels.CX_AZ, 'eu-west-1')\",\n", ")\n", "updateEventStreamTargetOptions.SetCompressionType(\"gzip\")\n", "updateEventStreamTargetOptions.SetIbmEventStreams(ibmEventStreamsModel)\n", "\n", "stream, response, err := logsService.UpdateEventStreamTarget(updateEventStreamTargetOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(stream, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Streams" ], "summary": "Delete an Event Stream integration by ID.", "description": "Delete an Event Stream integration by ID.", "operationId": "delete_event_stream_target", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.logs-stream-setup.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.logs-stream-setup.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/streams/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteEventStreamTargetOptions := logsService.NewDeleteEventStreamTargetOptions(\n", " int64(0),\n", ")\n", "\n", "response, err := logsService.DeleteEventStreamTarget(deleteEventStreamTargetOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteEventStreamTarget(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "The ID of the Event Stream.", "required": true, "schema": { "description": "The ID of the Event Stream.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "style": "simple", "x-linkback": "#/components/links/StreamID" } ] }, "/v1/views": { "get": { "tags": [ "Views" ], "summary": "Lists all company public views", "description": "Lists all company public views", "operationId": "list_views", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "views[*].{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.read" }, { "name": "logs.private-view.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/views\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "listViewsOptions := logsService.NewListViewsOptions()\n", "\n", "viewCollection, response, err := logsService.ListViews(listViewsOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(viewCollection, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "post": { "tags": [ "Views" ], "summary": "Creates a new view", "description": "Creates a new view", "operationId": "create_view", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPrototype" }, "example": { "filters": { "filters": [ { "name": "applicationName", "selected_values": { "demo": true } }, { "name": "subsystemName", "selected_values": { "demo": true } }, { "name": "operationName", "selected_values": { "demo": true } }, { "name": "serviceName", "selected_values": { "demo": true } }, { "name": "severity", "selected_values": { "demo": true } } ] }, "name": "Logs view", "search_query": { "query": "logs", "syntax_type": "dataprime" }, "time_selection": { "custom_selection": { "from_time": "2024-01-25T11:31:43.152Z", "to_time": "2024-01-25T11:37:13.238Z" } }, "tier": "all_logs" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } }, "links": { "ViewID": { "$ref": "#/components/links/ViewID" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "ViewPrototype", "x-cli-table-filter-jmespath": "{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" }, { "name": "logs.private-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X POST --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"filters\": {\n", " \"filters\": [\n", " {\n", " \"name\": \"applicationName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"subsystemName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"operationName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"serviceName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"severity\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " }\n", " ]\n", " },\n", " \"name\": \"Logs view\",\n", " \"search_query\": {\n", " \"query\": \"logs\",\n", " \"syntax_type\": \"dataprime\"\n", " },\n", " \"time_selection\": {\n", " \"custom_selection\": {\n", " \"from_time\": \"2024-01-25T11:31:43.152Z\",\n", " \"to_time\": \"2024-01-25T11:37:13.238Z\"\n", " }\n", " },\n", " \"tier\": \"all_logs\"\n", " }' \\\n", " \"${base_url}/v1/views\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisViewsV1CustomTimeSelectionModel := &logsv0.ApisViewsV1CustomTimeSelection{\n", " FromTime: CreateMockDateTime(\"2024-01-25T11:31:43.152Z\"),\n", " ToTime: CreateMockDateTime(\"2024-01-25T11:37:13.238Z\"),\n", "}\n", "\n", "apisViewsV1TimeSelectionModel := &logsv0.ApisViewsV1TimeSelectionSelectionTypeCustomSelection{\n", " CustomSelection: apisViewsV1CustomTimeSelectionModel,\n", "}\n", "\n", "apisViewsV1SearchQueryModel := &logsv0.ApisViewsV1SearchQuery{\n", " Query: core.StringPtr(\"logs\"),\n", " SyntaxType: core.StringPtr(\"dataprime\"),\n", "}\n", "\n", "apisViewsV1FilterModel := &logsv0.ApisViewsV1Filter{\n", " Name: core.StringPtr(\"applicationName\"),\n", "}\n", "\n", "apisViewsV1SelectedFiltersModel := &logsv0.ApisViewsV1SelectedFilters{\n", " Filters: []logsv0.ApisViewsV1Filter{*apisViewsV1FilterModel},\n", "}\n", "\n", "createViewOptions := logsService.NewCreateViewOptions(\n", " \"Logs view\",\n", " apisViewsV1TimeSelectionModel,\n", ")\n", "createViewOptions.SetSearchQuery(apisViewsV1SearchQueryModel)\n", "createViewOptions.SetFilters(apisViewsV1SelectedFiltersModel)\n", "createViewOptions.SetTier(\"all_logs\")\n", "\n", "view, response, err := logsService.CreateView(createViewOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(view, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } } }, "/v1/views/{id}": { "get": { "tags": [ "Views" ], "summary": "Gets a view by ID", "description": "Gets a view by ID", "operationId": "get_view", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-cli-table-filter-jmespath": "{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.read" }, { "name": "logs.private-view.read" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view.get" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X GET --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " \"${base_url}/v1/views/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "getViewOptions := logsService.NewGetViewOptions(\n", " int64(52),\n", ")\n", "\n", "view, response, err := logsService.GetView(getViewOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(view, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "put": { "tags": [ "Views" ], "summary": "Replaces an existing view", "description": "Replaces an existing view", "operationId": "replace_view", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewPrototype" }, "example": { "filters": { "filters": [ { "name": "applicationName", "selected_values": { "demo": true } }, { "name": "subsystemName", "selected_values": { "demo": true } }, { "name": "operationName", "selected_values": { "demo": true } }, { "name": "serviceName", "selected_values": { "demo": true } }, { "name": "severity", "selected_values": { "demo": true } } ] }, "name": "Logs view", "search_query": { "query": "logs new", "syntax_type": "lucene" }, "time_selection": { "custom_selection": { "from_time": "2024-01-25T11:31:43.152Z", "to_time": "2024-01-25T11:37:13.238Z" } }, "tier": "priority_insights_templates" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/View" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-codegen-request-body-name": "ViewPrototype", "x-cli-command": "view-update", "x-cli-table-filter-jmespath": "views[*].{Name:name,ID:id}", "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" }, { "name": "logs.private-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X PUT --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " --header \"Accept: application/json\" \\\n", " --header \"Content-Type: application/json\" \\\n", " --data '{\n", " \"filters\": {\n", " \"filters\": [\n", " {\n", " \"name\": \"applicationName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"subsystemName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"operationName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"serviceName\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " },\n", " {\n", " \"name\": \"severity\",\n", " \"selected_values\": {\n", " \"demo\": true\n", " }\n", " }\n", " ]\n", " },\n", " \"name\": \"Logs view\",\n", " \"search_query\": {\n", " \"query\": \"logs new\",\n", " \"syntax_type\": \"lucene\"\n", " },\n", " \"time_selection\": {\n", " \"custom_selection\": {\n", " \"from_time\": \"2024-01-25T11:31:43.152Z\",\n", " \"to_time\": \"2024-01-25T11:37:13.238Z\"\n", " }\n", " },\n", " \"tier\": \"priority_insights_templates\"\n", " }' \\\n", " \"${base_url}/v1/views/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "apisViewsV1CustomTimeSelectionModel := &logsv0.ApisViewsV1CustomTimeSelection{\n", " FromTime: CreateMockDateTime(\"2024-01-25T11:31:43.152Z\"),\n", " ToTime: CreateMockDateTime(\"2024-01-25T11:37:13.238Z\"),\n", "}\n", "\n", "apisViewsV1TimeSelectionModel := &logsv0.ApisViewsV1TimeSelectionSelectionTypeCustomSelection{\n", " CustomSelection: apisViewsV1CustomTimeSelectionModel,\n", "}\n", "\n", "apisViewsV1SearchQueryModel := &logsv0.ApisViewsV1SearchQuery{\n", " Query: core.StringPtr(\"logs new\"),\n", " SyntaxType: core.StringPtr(\"lucene\"),\n", "}\n", "\n", "apisViewsV1FilterModel := &logsv0.ApisViewsV1Filter{\n", " Name: core.StringPtr(\"applicationName\"),\n", "}\n", "\n", "apisViewsV1SelectedFiltersModel := &logsv0.ApisViewsV1SelectedFilters{\n", " Filters: []logsv0.ApisViewsV1Filter{*apisViewsV1FilterModel},\n", "}\n", "\n", "replaceViewOptions := logsService.NewReplaceViewOptions(\n", " int64(52),\n", " \"Logs view\",\n", " apisViewsV1TimeSelectionModel,\n", ")\n", "replaceViewOptions.SetSearchQuery(apisViewsV1SearchQueryModel)\n", "replaceViewOptions.SetFilters(apisViewsV1SelectedFiltersModel)\n", "replaceViewOptions.SetTier(\"priority_insights_templates\")\n", "\n", "view, response, err := logsService.ReplaceView(replaceViewOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "b, _ := json.MarshalIndent(view, \"\", \" \")\n", "fmt.Println(string(b))" ] } ] } ] } } }, "delete": { "tags": [ "Views" ], "summary": "Deletes a view by ID", "description": "Deletes a view by ID", "operationId": "delete_view", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "bad_request_or_unspecified", "message": "Bad request" } ], "status_code": 400, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthenticated", "message": "Unauthenticated" } ], "status_code": 401, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "unauthorized", "message": "Forbidden" } ], "status_code": 403, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "not_found", "message": "Not found" } ], "status_code": 404, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "408": { "description": "Unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "deadline_exceeded", "message": "Request timeout" } ], "status_code": 408, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "conflict", "message": "Conflict, resource already exists" } ], "status_code": 409, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "429": { "description": "Too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "resource_exhausted", "message": "Rate limit exceeded" } ], "status_code": 429, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" }, "example": { "errors": [ { "code": "method_internal_error", "message": "Internal server error" } ], "status_code": 500, "trace": "4199a60c-d9f9-4eb0-93e7-6faaa002062e" } } } } }, "x-ibm-permissions": { "actions": [ { "name": "logs.shared-view.manage" }, { "name": "logs.private-view.manage" } ] }, "x-ibm-events": { "events": [ { "name": "logs.view.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "curl -X DELETE --location --header \"Authorization: Bearer ${iam_token}\" \\\n", " \"${base_url}/v1/views/${id}\"" ] } ] } ], "go": [ { "name": "Example request", "example": [ { "type": "code", "source": [ "deleteViewOptions := logsService.NewDeleteViewOptions(\n", " int64(52),\n", ")\n", "\n", "response, err := logsService.DeleteView(deleteViewOptions)\n", "if err != nil {\n", " panic(err)\n", "}\n", "if response.StatusCode != 204 {\n", " fmt.Printf(\"\\nUnexpected response status code received from DeleteView(): %d\\n\", response.StatusCode)\n", "}" ] } ] } ] } } }, "parameters": [ { "in": "path", "name": "id", "description": "View ID", "required": true, "schema": { "example": 52, "description": "View ID", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "example": 52, "style": "simple", "x-linkback": "#/components/links/ViewID" } ] } }, "components": { "schemas": { "OpenapiV1ApiErrorErrorErrorCode": { "example": "deadline_exceeded", "description": "Error code", "type": "string", "enum": [ "bad_request_or_unspecified", "unauthorized", "forbidden", "not_found", "method_internal_error", "conflict", "unauthenticated", "resource_exhausted", "deadline_exceeded", "precondition_failed" ] }, "OpenapiV1ApiErrorError": { "description": "List of errors", "type": "object", "properties": { "code": { "$ref": "#/components/schemas/OpenapiV1ApiErrorErrorErrorCode" }, "message": { "example": "Not found", "description": "Human-readable error message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "more_info": { "example": "View not found", "description": "Additional information about the error", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "code" ] }, "ApiError": { "description": "ApiError is a message in a standardized error response format.\n It contains a list of individual errors, a trace identifier, and a status code.", "type": "object", "properties": { "errors": { "description": "List of errors", "type": "array", "items": { "$ref": "#/components/schemas/OpenapiV1ApiErrorError" }, "minItems": 0, "maxItems": 4096 }, "trace": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "UUID uniquely identifying the request", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "status_code": { "example": 404, "description": "HTTP status code associated with the error", "type": "integer", "format": "int32", "minimum": 0, "maximum": 999 } }, "required": [ "errors", "trace" ] }, "ApisAlertDefinitionLogFilterOperationType": { "example": "starts_with", "description": "The operation to perform on the label value", "type": "string", "enum": [ "is_or_unspecified", "includes", "ends_with", "starts_with" ] }, "ApisAlertDefinitionLabelFilterType": { "description": "Filter by application names.", "type": "object", "properties": { "value": { "example": "my-app", "description": "The value used to filter the label.", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 }, "operation": { "$ref": "#/components/schemas/ApisAlertDefinitionLogFilterOperationType" } }, "required": [ "operation" ] }, "ApisAlertDefinitionLogSeverity": { "example": "critical", "description": "Filter by log severities.", "type": "string", "enum": [ "verbose_unspecified", "debug", "info", "warning", "error", "critical" ] }, "ApisAlertDefinitionLabelFilters": { "description": "The label filters to filter logs.", "type": "object", "properties": { "application_name": { "description": "Filter by application names.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLabelFilterType" }, "minItems": 0, "maxItems": 4096 }, "subsystem_name": { "description": "Filter by subsystem names.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLabelFilterType" }, "minItems": 0, "maxItems": 4096 }, "severities": { "example": [ "critical" ], "description": "Filter by log severities.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogSeverity" }, "minItems": 0, "maxItems": 4096 } } }, "ApisAlertDefinitionLogsSimpleFilter": { "description": "A simple filter that uses a Lucene query and label filters", "type": "object", "properties": { "lucene_query": { "example": "text:\"error\"", "description": "The Lucene query to filter logs.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "label_filters": { "$ref": "#/components/schemas/ApisAlertDefinitionLabelFilters" } } }, "ApisAlertDefinitionLogsFilter": { "description": "The filter to match log entries for immediate alerts", "type": "object", "properties": { "simple_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsSimpleFilter" } } }, "ApisAlertDefinitionLogsImmediateType": { "description": "Configuration for immediate log-based alerts", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload.", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload.", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } } }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsImmediate": { "type": "object", "properties": { "logs_immediate": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsImmediateType" } } }, "ApisAlertDefinitionAutoRetireTimeframe": { "example": "hours_24", "description": "The timeframe for auto-retiring the alert when undetected values are detected", "type": "string", "enum": [ "never_or_unspecified", "minutes_5", "minutes_10", "hour_1", "hours_2", "hours_6", "hours_12", "hours_24" ] }, "ApisAlertDefinitionUndetectedValuesManagement": { "description": "Configuration for handling the undetected values in the alert", "type": "object", "properties": { "trigger_undetected_values": { "example": true, "description": "Should trigger the alert when undetected values are detected. If true, alert is triggered", "type": "boolean" }, "auto_retire_timeframe": { "$ref": "#/components/schemas/ApisAlertDefinitionAutoRetireTimeframe" } }, "required": [ "trigger_undetected_values", "auto_retire_timeframe" ] }, "ApisAlertDefinitionLogsTimeWindowValue": { "example": "hours_36", "description": "The time window defined for an alert to be triggered.", "type": "string", "enum": [ "minutes_5_or_unspecified", "minutes_10", "minutes_20", "minutes_15", "minutes_30", "hour_1", "hours_2", "hours_4", "hours_6", "hours_12", "hours_24", "hours_36" ] }, "ApisAlertDefinitionLogsTimeWindow": { "description": "The time window for the alert condition", "type": "object", "properties": { "logs_time_window_specific_value": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeWindowValue" } }, "required": [ "logs_time_window_specific_value" ] }, "ApisAlertDefinitionLogsThresholdConditionType": { "example": "less_than", "description": "The condition type for the alert", "type": "string", "enum": [ "more_than_or_unspecified", "less_than" ] }, "ApisAlertDefinitionLogsThresholdCondition": { "description": "The condition for the threshold alert", "type": "object", "properties": { "threshold": { "example": 100, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "time_window": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeWindow" } }, "required": [ "threshold", "time_window" ] }, "ApisAlertDefinitionAlertDefPriority": { "example": "p1", "description": "The priority of the alert definition", "type": "string", "enum": [ "p5_or_unspecified", "p4", "p3", "p2", "p1" ] }, "ApisAlertDefinitionAlertDefOverride": { "description": "The override settings for the alert.", "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPriority" } }, "required": [ "priority" ] }, "ApisAlertDefinitionLogsThresholdRule": { "description": "The condition rules for the threshold alert.", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsThresholdCondition" }, "override": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefOverride" } }, "required": [ "condition", "override" ] }, "ApisAlertDefinitionLogsThresholdType": { "description": "Configuration for the log-based threshold alerts", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "undetected_values_management": { "$ref": "#/components/schemas/ApisAlertDefinitionUndetectedValuesManagement" }, "rules": { "description": "The condition rules for the threshold alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsThresholdRule" }, "minItems": 1, "maxItems": 5 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsThresholdConditionType" }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "rules", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsThreshold": { "type": "object", "properties": { "logs_threshold": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsThresholdType" } } }, "ApisAlertDefinitionLogsRatioTimeWindowValue": { "example": "hours_36", "description": "Specifies the time window for the ratio alert", "type": "string", "enum": [ "minutes_5_or_unspecified", "minutes_10", "minutes_15", "minutes_30", "hour_1", "hours_2", "hours_4", "hours_6", "hours_12", "hours_24", "hours_36" ] }, "ApisAlertDefinitionLogsRatioTimeWindow": { "description": "The time window for the alert condition", "type": "object", "properties": { "logs_ratio_time_window_specific_value": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioTimeWindowValue" } }, "required": [ "logs_ratio_time_window_specific_value" ] }, "ApisAlertDefinitionLogsRatioConditionType": { "example": "less_than", "description": "The condition type for the alert", "type": "string", "enum": [ "more_than_or_unspecified", "less_than" ] }, "ApisAlertDefinitionLogsRatioCondition": { "description": "The condition for the ratio alert", "type": "object", "properties": { "threshold": { "example": 10, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "time_window": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioTimeWindow" } }, "required": [ "threshold", "time_window" ] }, "ApisAlertDefinitionLogsRatioRules": { "description": "The condition rules for the ratio alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioCondition" }, "override": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefOverride" } }, "required": [ "condition", "override" ] }, "ApisAlertDefinitionLogsRatioGroupByFor": { "example": "denumerator_only", "description": "The group by settings for the numerator and denominator filters", "type": "string", "enum": [ "both_or_unspecified", "numerator_only", "denumerator_only" ] }, "ApisAlertDefinitionLogsRatioThresholdType": { "description": "Configuration for the log-based ratio threshold alerts", "type": "object", "properties": { "numerator": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "numerator_alias": { "example": "numerator_alias", "description": "The alias for the numerator filter, used for display purposes", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "denominator": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "denominator_alias": { "example": "denominator_alias", "description": "The alias for the denominator filter, used for display purposes", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "rules": { "description": "The condition rules for the ratio alert.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioRules" }, "minItems": 1, "maxItems": 5 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioConditionType" }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload.", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload.", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "group_by_for": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioGroupByFor" }, "undetected_values_management": { "$ref": "#/components/schemas/ApisAlertDefinitionUndetectedValuesManagement" }, "ignore_infinity": { "example": true, "description": "Determine whether to ignore an infinity result or not. If true, alert is not triggered.\nWhen the value of second query is 0, the result of the ratio will be infinity.", "type": "boolean" }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "numerator", "denominator", "rules", "group_by_for", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsRatioThreshold": { "type": "object", "properties": { "logs_ratio_threshold": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsRatioThresholdType" } } }, "ApisAlertDefinitionLogsTimeRelativeComparedTo": { "example": "same_day_last_month", "description": "The time frame to compare the current value against", "type": "string", "enum": [ "previous_hour_or_unspecified", "same_hour_yesterday", "same_hour_last_week", "yesterday", "same_day_last_week", "same_day_last_month" ] }, "ApisAlertDefinitionLogsTimeRelativeConditionType": { "example": "less_than", "description": "The delay in milliseconds before evaluating the alert condition", "type": "string", "enum": [ "more_than_or_unspecified", "less_than" ] }, "ApisAlertDefinitionLogsTimeRelativeCondition": { "description": "The condition for the time-relative alert", "type": "object", "properties": { "threshold": { "example": 100, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "compared_to": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeRelativeComparedTo" } }, "required": [ "threshold", "compared_to" ] }, "ApisAlertDefinitionLogsTimeRelativeRule": { "description": "The condition rules for the time-relative alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeRelativeCondition" }, "override": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefOverride" } }, "required": [ "condition", "override" ] }, "ApisAlertDefinitionLogsTimeRelativeThresholdType": { "description": "Configuration for time-relative log threshold alerts", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "rules": { "description": "The condition rules for the time-relative alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeRelativeRule" }, "minItems": 1, "maxItems": 5 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeRelativeConditionType" }, "ignore_infinity": { "example": true, "description": "Ignore infinity values in the alert", "type": "boolean" }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "undetected_values_management": { "$ref": "#/components/schemas/ApisAlertDefinitionUndetectedValuesManagement" }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "rules", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsTimeRelativeThreshold": { "type": "object", "properties": { "logs_time_relative_threshold": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeRelativeThresholdType" } } }, "ApisAlertDefinitionMetricFilter": { "description": "The filter to match metric entries for the alert", "type": "object", "properties": { "promql": { "example": "avg_over_time(metric_name[5m]) > 10", "description": "The filter is a PromQL expression.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "promql" ] }, "ApisAlertDefinitionMetricTimeWindowValue": { "example": "hours_36", "description": "The time window as a specific value", "type": "string", "enum": [ "minutes_1_or_unspecified", "minutes_5", "minutes_10", "minutes_15", "minutes_30", "hour_1", "hours_2", "hours_4", "hours_6", "hours_12", "hours_24", "minutes_20", "hours_36" ] }, "ApisAlertDefinitionMetricTimeWindowTypeMetricTimeWindowSpecificValue": { "type": "object", "properties": { "metric_time_window_specific_value": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricTimeWindowValue" } } }, "ApisAlertDefinitionMetricTimeWindowTypeMetricTimeWindowDynamicDuration": { "type": "object", "properties": { "metric_time_window_dynamic_duration": { "example": "1h30m", "description": "The time window as a dynamic value", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisAlertDefinitionMetricTimeWindow": { "description": "The time window for the alert condition", "oneOf": [ { "$ref": "#/components/schemas/ApisAlertDefinitionMetricTimeWindowTypeMetricTimeWindowSpecificValue" }, { "$ref": "#/components/schemas/ApisAlertDefinitionMetricTimeWindowTypeMetricTimeWindowDynamicDuration" } ] }, "ApisAlertDefinitionMetricThresholdConditionType": { "example": "less_than_or_equals", "description": "The type of the alert condition", "type": "string", "enum": [ "more_than_or_unspecified", "less_than", "more_than_or_equals", "less_than_or_equals" ] }, "ApisAlertDefinitionMetricThresholdCondition": { "description": "The condition for the metric threshold alert", "type": "object", "properties": { "threshold": { "example": 100, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "for_over_pct": { "example": 80, "description": "The percentage of values that must exceed the threshold to trigger the\n alert", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "of_the_last": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricTimeWindow" } }, "required": [ "threshold", "for_over_pct", "of_the_last" ] }, "ApisAlertDefinitionMetricThresholdRule": { "description": "The condition rules for the metric threshold alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricThresholdCondition" }, "override": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefOverride" } }, "required": [ "condition", "override" ] }, "ApisAlertDefinitionMetricMissingValuesMissingValuesReplaceWithZero": { "type": "object", "properties": { "replace_with_zero": { "example": true, "description": "If set to true, missing values will be replaced with zero", "type": "boolean" } } }, "ApisAlertDefinitionMetricMissingValuesMissingValuesMinNonNullValuesPct": { "type": "object", "properties": { "min_non_null_values_pct": { "example": 80, "description": "If set, specifies the minimum percentage of non-null values required for the alert to be triggered", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "ApisAlertDefinitionMetricMissingValues": { "description": "Configuration for handling missing values in the alert. Only one of `replace_with_zero` or `min_non_null_value_pct` is supported.", "oneOf": [ { "$ref": "#/components/schemas/ApisAlertDefinitionMetricMissingValuesMissingValuesReplaceWithZero" }, { "$ref": "#/components/schemas/ApisAlertDefinitionMetricMissingValuesMissingValuesMinNonNullValuesPct" } ] }, "ApisAlertDefinitionMetricThresholdType": { "description": "Configuration for metric-based threshold alerts", "type": "object", "properties": { "metric_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricFilter" }, "rules": { "description": "The condition rules for the metric threshold alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricThresholdRule" }, "minItems": 1, "maxItems": 5 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricThresholdConditionType" }, "undetected_values_management": { "$ref": "#/components/schemas/ApisAlertDefinitionUndetectedValuesManagement" }, "missing_values": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricMissingValues" }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "metric_filter", "rules", "missing_values", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricThreshold": { "type": "object", "properties": { "metric_threshold": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricThresholdType" } } }, "ApisAlertDefinitionTimeframeType": { "example": "up_to", "description": "The type of timeframe for the flow alert", "type": "string", "enum": [ "unspecified", "up_to" ] }, "ApisAlertDefinitionFlowStagesGroupsAlertDefs": { "description": "The alert definitions for the flow stage group", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The alert definition ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "not": { "example": true, "description": "Whether or not to negate the alert definition. If true, flow checks for the negate condition of the respective alert.", "type": "boolean" } }, "required": [ "id" ] }, "ApisAlertDefinitionNextOp": { "example": "or", "description": "The logical operation to apply to the next stage", "type": "string", "enum": [ "and_or_unspecified", "or" ] }, "ApisAlertDefinitionAlertsOp": { "example": "or", "description": "The logical operation to apply to the alerts in the group", "type": "string", "enum": [ "and_or_unspecified", "or" ] }, "ApisAlertDefinitionFlowStagesGroup": { "description": "Defines a group of alerts and the logical operations applied both among the alerts and to the group within the flow alert.", "type": "object", "properties": { "alert_defs": { "description": "The alert definitions for the flow stage group", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionFlowStagesGroupsAlertDefs" }, "minItems": 1, "maxItems": 4096 }, "next_op": { "$ref": "#/components/schemas/ApisAlertDefinitionNextOp" }, "alerts_op": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertsOp" } }, "required": [ "alert_defs", "next_op", "alerts_op" ] }, "ApisAlertDefinitionFlowStagesGroups": { "description": "The definition of groups in the flow alert.", "type": "object", "properties": { "groups": { "description": "The definition of an array of groups with alerts and logical operation among those alerts in the flow alert.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionFlowStagesGroup" }, "minItems": 1, "maxItems": 4096 } }, "required": [ "groups" ] }, "ApisAlertDefinitionFlowStages": { "description": "The definition of stages of the flow alert", "type": "object", "properties": { "timeframe_ms": { "example": "60000", "description": "The timeframe for the flow alert in milliseconds", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 }, "timeframe_type": { "$ref": "#/components/schemas/ApisAlertDefinitionTimeframeType" }, "flow_stages_groups": { "$ref": "#/components/schemas/ApisAlertDefinitionFlowStagesGroups" } }, "required": [ "timeframe_ms", "timeframe_type", "flow_stages_groups" ] }, "ApisAlertDefinitionFlowType": { "description": "Configuration for flow alerts", "type": "object", "properties": { "stages": { "description": "The definition of stages of the flow alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionFlowStages" }, "minItems": 1, "maxItems": 4096 }, "enforce_suppression": { "example": true, "description": "Whether to enforce suppression for the flow alert", "type": "boolean" } }, "required": [ "stages" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionFlow": { "type": "object", "properties": { "flow": { "$ref": "#/components/schemas/ApisAlertDefinitionFlowType" } } }, "ApisAlertDefinitionLogsAnomalyConditionType": { "example": "more_than_usual_or_unspecified", "description": "The condition type for the alert", "type": "string", "enum": [ "more_than_usual_or_unspecified" ] }, "ApisAlertDefinitionLogsAnomalyCondition": { "description": "The condition for the anomaly alert", "type": "object", "properties": { "minimum_threshold": { "example": 10, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "time_window": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsTimeWindow" } }, "required": [ "minimum_threshold", "time_window" ] }, "ApisAlertDefinitionLogsAnomalyRule": { "description": "The condition rules for the log anomaly alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsAnomalyCondition" } }, "required": [ "condition" ] }, "ApisAlertDefinitionAnomalyAlertSettings": { "description": "The anomaly alert settings configuration", "type": "object", "properties": { "percentage_of_deviation": { "example": 10, "description": "The percentage of deviation from the baseline when the alert is triggered.", "type": "number", "format": "float" } } }, "ApisAlertDefinitionLogsAnomalyType": { "description": "Configuration for the log-based anomaly detection alerts", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "rules": { "description": "The condition rules for the log anomaly alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsAnomalyRule" }, "minItems": 1, "maxItems": 1 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsAnomalyConditionType" }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The notification payload filter to specify which fields are included in the notification", "type": "array", "items": { "description": "The notification payload filter to specify which fields are included in the notification", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "anomaly_alert_settings": { "$ref": "#/components/schemas/ApisAlertDefinitionAnomalyAlertSettings" } }, "required": [ "rules", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsAnomaly": { "type": "object", "properties": { "logs_anomaly": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsAnomalyType" } } }, "ApisAlertDefinitionMetricAnomalyConditionType": { "example": "less_than_usual", "description": "The condition type for the alert", "type": "string", "enum": [ "more_than_usual_or_unspecified", "less_than_usual" ] }, "ApisAlertDefinitionMetricAnomalyCondition": { "description": "The condition for the metric anomaly alert", "type": "object", "properties": { "threshold": { "example": 10, "description": "The threshold value for the alert condition", "type": "number", "format": "double" }, "for_over_pct": { "example": 20, "description": "The percentage of the metric values that must exceed the threshold to trigger the alert", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "of_the_last": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricTimeWindow" }, "min_non_null_values_pct": { "example": 10, "description": "The percentage of non-null values required to trigger the alert", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "threshold", "of_the_last", "min_non_null_values_pct" ] }, "ApisAlertDefinitionMetricAnomalyRule": { "description": "The condition rules for the metric anomaly alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricAnomalyCondition" } }, "required": [ "condition" ] }, "ApisAlertDefinitionMetricAnomalyType": { "description": "Configuration for metric-based anomaly detection alerts", "type": "object", "properties": { "metric_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricFilter" }, "rules": { "description": "The condition rules for the metric anomaly alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricAnomalyRule" }, "minItems": 1, "maxItems": 1 }, "condition_type": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricAnomalyConditionType" }, "evaluation_delay_ms": { "example": 60000, "description": "The delay in milliseconds before evaluating the alert condition", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "anomaly_alert_settings": { "$ref": "#/components/schemas/ApisAlertDefinitionAnomalyAlertSettings" } }, "required": [ "metric_filter", "rules", "condition_type" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricAnomaly": { "type": "object", "properties": { "metric_anomaly": { "$ref": "#/components/schemas/ApisAlertDefinitionMetricAnomalyType" } } }, "ApisAlertDefinitionLogsNewValueTimeWindowValue": { "example": "months_3", "description": "A time window defined by a specific value", "type": "string", "enum": [ "hours_12_or_unspecified", "hours_24", "hours_48", "hours_72", "week_1", "month_1", "months_2", "months_3" ] }, "ApisAlertDefinitionLogsNewValueTimeWindow": { "description": "The time window for detecting new values", "type": "object", "properties": { "logs_new_value_time_window_specific_value": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsNewValueTimeWindowValue" } }, "required": [ "logs_new_value_time_window_specific_value" ] }, "ApisAlertDefinitionLogsNewValueCondition": { "description": "The condition for detecting new values in logs", "type": "object", "properties": { "keypath_to_track": { "example": "metadata.field", "description": "The keypath to track for new values", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "time_window": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsNewValueTimeWindow" } }, "required": [ "keypath_to_track", "time_window" ] }, "ApisAlertDefinitionLogsNewValueRule": { "description": "The condition rules for the log new value alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsNewValueCondition" } }, "required": [ "condition" ] }, "ApisAlertDefinitionLogsNewValueType": { "description": "Configuration for alerts triggered by new log values", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "rules": { "description": "The condition rules for the log new value alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsNewValueRule" }, "minItems": 1, "maxItems": 1 }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } }, "required": [ "rules" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsNewValue": { "type": "object", "properties": { "logs_new_value": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsNewValueType" } } }, "ApisAlertDefinitionLogsUniqueValueTimeWindowValue": { "example": "hours_36", "description": "A time window defined by a specific value", "type": "string", "enum": [ "minute_1_or_unspecified", "minutes_15", "minutes_20", "minutes_30", "hours_1", "hours_2", "hours_4", "hours_6", "hours_12", "hours_24", "minutes_5", "minutes_10", "hours_36" ] }, "ApisAlertDefinitionLogsUniqueValueTimeWindow": { "description": "The time window for the unique count alert", "type": "object", "properties": { "logs_unique_value_time_window_specific_value": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsUniqueValueTimeWindowValue" } }, "required": [ "logs_unique_value_time_window_specific_value" ] }, "ApisAlertDefinitionLogsUniqueCountCondition": { "description": "The condition for detecting unique counts in logs", "type": "object", "properties": { "max_unique_count": { "example": "100", "description": "The maximum unique count for the alert condition", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 }, "time_window": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsUniqueValueTimeWindow" } }, "required": [ "max_unique_count", "time_window" ] }, "ApisAlertDefinitionLogsUniqueCountRule": { "description": "Rules defining the conditions for the unique count alert", "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsUniqueCountCondition" } }, "required": [ "condition" ] }, "ApisAlertDefinitionLogsUniqueCountType": { "description": "Configuration for alerts based on unique log value counts", "type": "object", "properties": { "logs_filter": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsFilter" }, "rules": { "description": "Rules defining the conditions for the unique count alert", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsUniqueCountRule" }, "minItems": 1, "maxItems": 1 }, "notification_payload_filter": { "example": [ "obj.field" ], "description": "The filter to specify which fields are included in the notification payload", "type": "array", "items": { "description": "The filter to specify which fields are included in the notification payload", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "max_unique_count_per_group_by_key": { "example": "100", "description": "The maximum unique count per group by key", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 }, "unique_count_keypath": { "example": "obj.field", "description": "The keypath in the logs to be used for unique count", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "rules", "unique_count_keypath" ] }, "ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsUniqueCount": { "type": "object", "properties": { "logs_unique_count": { "$ref": "#/components/schemas/ApisAlertDefinitionLogsUniqueCountType" } } }, "ApisAlertDefinitionDayOfWeek": { "example": "sunday", "description": "Days of the week when the alert is active.", "type": "string", "enum": [ "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "ApisAlertDefinitionTimeOfDay": { "description": "Start time of the alert activity", "type": "object", "properties": { "hours": { "example": 14, "description": "The hour of the day in 24-hour format. Must be an integer between 0 and 23.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 }, "minutes": { "example": 30, "description": "Minute of the hour of the day. Must be an integer between 0 and 59.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 } } }, "ApisAlertDefinitionActivitySchedule": { "description": "Defining when the alert is active", "type": "object", "properties": { "day_of_week": { "example": [ "sunday" ], "description": "Days of the week when the alert is active.", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionDayOfWeek" }, "minItems": 1, "maxItems": 7 }, "start_time": { "$ref": "#/components/schemas/ApisAlertDefinitionTimeOfDay" }, "end_time": { "$ref": "#/components/schemas/ApisAlertDefinitionTimeOfDay" } }, "required": [ "day_of_week", "start_time", "end_time" ] }, "ApisAlertDefinitionAlertDefType": { "example": "flow", "description": "Alert type", "type": "string", "enum": [ "logs_immediate_or_unspecified", "logs_threshold", "logs_anomaly", "logs_ratio_threshold", "logs_new_value", "logs_unique_count", "logs_time_relative_threshold", "metric_threshold", "metric_anomaly", "flow" ] }, "ApisAlertDefinitionNotifyOn": { "example": "triggered_and_resolved", "description": "Indicate if the alert should be triggered or triggered and resolved.", "type": "string", "enum": [ "triggered_only_unspecified", "triggered_and_resolved" ] }, "ApisAlertDefinitionAlertDefIncidentSettings": { "description": "Incident creation and management settings", "type": "object", "properties": { "notify_on": { "$ref": "#/components/schemas/ApisAlertDefinitionNotifyOn" }, "minutes": { "example": 30, "description": "The time in minutes before the alert can be triggered again", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "ApisAlertDefinitionIntegrationTypeIntegrationTypeIntegrationId": { "type": "object", "properties": { "integration_id": { "example": 123, "description": "The integration ID for the notification", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "ApisAlertDefinitionIntegrationType": { "description": "The integration type for webhook notifications", "oneOf": [ { "$ref": "#/components/schemas/ApisAlertDefinitionIntegrationTypeIntegrationTypeIntegrationId" } ] }, "ApisAlertDefinitionAlertDefWebhooksSettings": { "description": "The settings for webhooks associated with the alert definition", "type": "object", "properties": { "notify_on": { "$ref": "#/components/schemas/ApisAlertDefinitionNotifyOn" }, "integration": { "$ref": "#/components/schemas/ApisAlertDefinitionIntegrationType" }, "minutes": { "example": 15, "description": "The time in minutes before the notification is sent", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "integration" ] }, "ApisAlertDefinitionAlertDefNotificationGroup": { "description": "Primary notification group for alert events", "type": "object", "properties": { "group_by_keys": { "example": [ "key1", "key2" ], "description": "Group the alerts by these keys.", "type": "array", "items": { "description": "Group the alerts by these keys.", "type": "string", "pattern": "^[a-zA-Z0-9_.]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "webhooks": { "description": "The settings for webhooks associated with the alert definition", "type": "array", "items": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefWebhooksSettings" }, "minItems": 0, "maxItems": 4096 } } }, "EntityLabelsEntry": { "example": { "key": "value" }, "description": "Labels used to identify and categorize the alert entity", "type": "object", "additionalProperties": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "AlertDefinitionPrototype": { "example": { "active_on": { "day_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "end_time": { "hours": 21, "minutes": 59 }, "start_time": { "hours": 22 } }, "deleted": false, "description": "Example Alert definition", "enabled": true, "incidents_settings": { "minutes": 10, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "more_than_or_unspecified", "rules": [ { "condition": { "threshold": 1, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ] }, "name": "Alert 1738141279354", "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold" }, "description": "Request model to create or update an alert. Only one alert type configuration is allowed and must be the same as in `type` field.", "properties": { "name": { "example": "Unique count alert", "description": "The name of the alert definition", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Example of unique count alert from terraform", "description": "A detailed description of what the alert monitors and when it triggers", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "enabled": { "example": true, "description": "Whether the alert is currently active and monitoring", "type": "boolean" }, "priority": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPriority" }, "active_on": { "$ref": "#/components/schemas/ApisAlertDefinitionActivitySchedule" }, "type": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefType" }, "group_by_keys": { "example": [ "key1", "key2" ], "description": "Keys used to group and aggregate alert data. Not supported for `logs_new_value` alert type.", "type": "array", "items": { "description": "Keys used to group and aggregate alert data", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 2 }, "incidents_settings": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefIncidentSettings" }, "notification_group": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefNotificationGroup" }, "entity_labels": { "$ref": "#/components/schemas/EntityLabelsEntry" }, "phantom_mode": { "example": false, "description": "Whether the alert is in phantom mode (creating incidents or not)\nPhantom alerts serve as building blocks for flow alerts without triggering independent notifications. \nEnabling this will remove the 'Notifications' section from the alert definition.", "type": "boolean" }, "deleted": { "example": false, "description": "Whether the alert has been marked as deleted", "type": "boolean" } }, "required": [ "name", "type" ], "oneOf": [ { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsImmediate" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsRatioThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsTimeRelativeThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionFlow" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsAnomaly" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricAnomaly" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsNewValue" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsUniqueCount" } ] }, "AlertDefinition": { "example": { "active_on": { "day_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "end_time": { "hours": 21, "minutes": 59 }, "start_time": { "hours": 22 } }, "alert_version_id": "002bc3e4-dba2-4e72-8826-7374b4e960c0", "created_time": "2025-01-29T09:01:22.000Z", "deleted": false, "description": "Example Alert definition", "enabled": true, "entity_labels": {}, "group_by_keys": [], "id": "95c0d440-14fe-4926-a3e6-0f326f7a02eb", "incidents_settings": { "minutes": 10, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "more_than_or_unspecified", "logs_filter": { "simple_filter": { "label_filters": { "application_name": [], "severities": [], "subsystem_name": [] } } }, "notification_payload_filter": [], "rules": [ { "condition": { "threshold": 1, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ] }, "name": "Alert 1738141279354", "notification_group": { "group_by_keys": [], "webhooks": [] }, "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold", "updated_time": "2025-01-29T09:01:22.000Z" }, "description": "Response model for a given alert definition", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "This is the alert definition's persistent ID (UniqueIdentifier). This ID does not change when the alert is updated.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "created_time": { "example": "2021-01-01T00:00:00.000Z", "description": "The time when the alert definition was created", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "updated_time": { "example": "2021-01-01T00:00:00.000Z", "description": "The time when the alert definition was last updated", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "alert_version_id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The previous or old alert ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Unique count alert", "description": "The name of the alert definition", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Example of unique count alert from terraform", "description": "A detailed description of what the alert monitors and when it triggers", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "enabled": { "example": true, "description": "Whether the alert is currently active and monitoring. If true, alert is active.", "type": "boolean" }, "priority": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPriority" }, "active_on": { "$ref": "#/components/schemas/ApisAlertDefinitionActivitySchedule" }, "type": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefType" }, "group_by_keys": { "example": [ "key1", "key2" ], "description": "Keys used to group and aggregate alert data", "type": "array", "items": { "description": "Keys used to group and aggregate alert data", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 2 }, "incidents_settings": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefIncidentSettings" }, "notification_group": { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefNotificationGroup" }, "entity_labels": { "$ref": "#/components/schemas/EntityLabelsEntry" }, "phantom_mode": { "example": false, "description": "Whether the alert is in phantom mode (creating incidents or not)", "type": "boolean" }, "deleted": { "example": false, "description": "Whether the alert has been marked as deleted", "type": "boolean" } }, "required": [ "id", "name", "type" ], "oneOf": [ { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsImmediate" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsRatioThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsTimeRelativeThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricThreshold" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionFlow" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsAnomaly" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionMetricAnomaly" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsNewValue" }, { "$ref": "#/components/schemas/ApisAlertDefinitionAlertDefPropertiesTypeDefinitionLogsUniqueCount" } ] }, "AlertDefinitionCollection": { "example": { "alert_definitions": [ { "active_on": { "day_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "end_time": { "hours": 21, "minutes": 59 }, "start_time": { "hours": 22 } }, "alert_version_id": "002bc3e4-dba2-4e72-8826-7374b4e960c0", "created_time": "2025-01-29T09:01:22.000Z", "deleted": false, "description": "Example Alert definition", "enabled": true, "entity_labels": {}, "group_by_keys": [], "id": "95c0d440-14fe-4926-a3e6-0f326f7a02eb", "incidents_settings": { "minutes": 10, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "more_than_or_unspecified", "logs_filter": { "simple_filter": { "label_filters": { "application_name": [], "severities": [], "subsystem_name": [] } } }, "notification_payload_filter": [], "rules": [ { "condition": { "threshold": 1, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ] }, "name": "Alert 1738141279354", "notification_group": { "group_by_keys": [], "webhooks": [] }, "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold", "updated_time": "2025-01-29T09:01:22.000Z" }, { "alert_def_properties": { "deleted": false, "enabled": true, "entity_labels": {}, "group_by_keys": [ "coralogix.metadata.applicationName" ], "incidents_settings": { "minutes": 1, "notify_on": "triggered_only_unspecified" }, "logs_threshold": { "condition_type": "less_than", "logs_filter": { "simple_filter": { "label_filters": { "application_name": [], "severities": [], "subsystem_name": [] } } }, "notification_payload_filter": [], "rules": [ { "condition": { "threshold": 50, "time_window": { "logs_time_window_specific_value": "minutes_10" } }, "override": { "priority": "p5_or_unspecified" } } ], "undetected_values_management": { "auto_retire_timeframe": "never_or_unspecified", "trigger_undetected_values": true } }, "name": "SCC services absence alerts - DEV-pagerduty-82aa7d31f8", "notification_group": { "group_by_keys": [ "coralogix.logId" ], "webhooks": [] }, "phantom_mode": false, "priority": "p5_or_unspecified", "type": "logs_threshold" }, "alert_version_id": "013481ef-8de2-4c98-82a7-5b0b108b298f", "created_time": "2024-07-02T13:17:04.000Z", "id": "6f1e4043-10dc-4cd6-95a0-b70cdf196391", "updated_time": "2024-07-02T13:17:04.000Z" } ] }, "description": "Response model for list of alert definitions", "type": "object", "properties": { "alert_definitions": { "description": "List of alert definitions", "type": "array", "items": { "$ref": "#/components/schemas/AlertDefinition" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "alert_definitions" ] }, "AlertsV1AlertSeverity": { "example": "error", "description": "Alert severity", "type": "string", "enum": [ "info_or_unspecified", "warning", "critical", "error" ] }, "AlertsV1Date": { "description": "Alert expiration date", "type": "object", "properties": { "year": { "example": 2012, "description": "Year", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "month": { "example": 12, "description": "Month of the year", "type": "integer", "format": "int32", "minimum": 1, "maximum": 12 }, "day": { "example": 24, "description": "Day of the month", "type": "integer", "format": "int32", "minimum": 1, "maximum": 31 } } }, "AlertsV2ImmediateConditionEmpty": { "description": "Condition for immediate standard alert", "type": "object" }, "AlertsV2AlertConditionConditionImmediate": { "type": "object", "properties": { "immediate": { "$ref": "#/components/schemas/AlertsV2ImmediateConditionEmpty" } } }, "AlertsV1Timeframe": { "example": "timeframe_36_h", "description": "The timeframe for the alert condition", "type": "string", "enum": [ "timeframe_5_min_or_unspecified", "timeframe_10_min", "timeframe_20_min", "timeframe_30_min", "timeframe_1_h", "timeframe_2_h", "timeframe_3_h", "timeframe_4_h", "timeframe_6_h", "timeframe_12_h", "timeframe_24_h", "timeframe_48_h", "timeframe_72_h", "timeframe_1_w", "timeframe_1_m", "timeframe_2_m", "timeframe_3_m", "timeframe_15_min", "timeframe_1_min", "timeframe_2_min", "timeframe_36_h" ] }, "AlertsV1MetricAlertConditionParametersMetricSource": { "example": "prometheus", "description": "The metric source of the metric alert", "type": "string", "enum": [ "logs2metrics_or_unspecified", "prometheus" ] }, "AlertsV1MetricAlertConditionParametersArithmeticOperator": { "example": "percentile", "description": "The arithmetic operator of the metric PromQL alert", "type": "string", "enum": [ "avg_or_unspecified", "min", "max", "sum", "count", "percentile" ] }, "AlertsV1MetricAlertConditionParameters": { "description": "The Lucene metric alert parameters if it is a lucene metric alert", "type": "object", "properties": { "metric_field": { "example": "cpu_usage", "description": "The metric field of the metric alert", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "metric_source": { "$ref": "#/components/schemas/AlertsV1MetricAlertConditionParametersMetricSource" }, "arithmetic_operator": { "$ref": "#/components/schemas/AlertsV1MetricAlertConditionParametersArithmeticOperator" }, "arithmetic_operator_modifier": { "example": 1, "description": "The arithmetic operator modifier of the metric PromQL alert", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "sample_threshold_percentage": { "example": 100, "description": "The threshold percentage", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "non_null_percentage": { "example": 100, "description": "The percentage of the evaluation as a value between 0 and 100.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "swap_null_values": { "example": true, "description": "Indicates whether null values are replaced with zero values.", "type": "boolean" } }, "required": [ "metric_field", "metric_source", "arithmetic_operator" ] }, "AlertsV1MetricAlertPromqlConditionParameters": { "description": "The parameters for a PromQL metric alert", "type": "object", "properties": { "promql_text": { "example": "sum(rate(container_cpu_usage_seconds_total{container_name=\"my-container\"}[5m])) by (pod_name)", "description": "The PromQL text of the metric alert by fields for the alert condition", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "arithmetic_operator_modifier": { "example": 1, "description": "The arithmetic operator of the metric PromQL alert", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "sample_threshold_percentage": { "example": 100, "description": "The threshold percentage", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "non_null_percentage": { "example": 100, "description": "The percentage of the evaluation as a value between 0 and 100.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "swap_null_values": { "example": true, "description": "Indicates whether null values are replaced with zero values.", "type": "boolean" } }, "required": [ "promql_text", "sample_threshold_percentage" ] }, "AlertsV1RelativeTimeframe": { "example": "month", "description": "The relative timeframe for time relative alerts", "type": "string", "enum": [ "hour_or_unspecified", "day", "week", "month" ] }, "AlertsV1CleanupDeadmanDuration": { "example": "cleanup_deadman_duration_24h", "description": "Cleanup deadman duration", "type": "string", "enum": [ "cleanup_deadman_duration_never_or_unspecified", "cleanup_deadman_duration_5min", "cleanup_deadman_duration_10min", "cleanup_deadman_duration_1h", "cleanup_deadman_duration_2h", "cleanup_deadman_duration_6h", "cleanup_deadman_duration_12h", "cleanup_deadman_duration_24h" ] }, "AlertsV1RelatedExtendedData": { "description": "Deadman configuration", "type": "object", "properties": { "cleanup_deadman_duration": { "$ref": "#/components/schemas/AlertsV1CleanupDeadmanDuration" }, "should_trigger_deadman": { "example": true, "description": "Should we trigger deadman", "type": "boolean" } } }, "AlertsV2ConditionParameters": { "description": "The Less than alert condition parameters", "type": "object", "properties": { "threshold": { "example": 0.4, "description": "The threshold for the alert condition", "type": "number", "format": "double" }, "timeframe": { "$ref": "#/components/schemas/AlertsV1Timeframe" }, "group_by": { "example": [ "message.severity" ], "description": "The group by fields for the alert condition", "type": "array", "items": { "description": "The group by fields for the alert condition", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 256 }, "minItems": 0, "maxItems": 3 }, "metric_alert_parameters": { "$ref": "#/components/schemas/AlertsV1MetricAlertConditionParameters" }, "metric_alert_promql_parameters": { "$ref": "#/components/schemas/AlertsV1MetricAlertPromqlConditionParameters" }, "ignore_infinity": { "example": true, "description": "Should the evaluation ignore infinity value", "type": "boolean" }, "relative_timeframe": { "$ref": "#/components/schemas/AlertsV1RelativeTimeframe" }, "cardinality_fields": { "example": [ "message.severity" ], "description": "Cardinality fields for unique count alert", "type": "array", "items": { "description": "Cardinality fields for unique count alert", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "related_extended_data": { "$ref": "#/components/schemas/AlertsV1RelatedExtendedData" } }, "required": [ "timeframe" ] }, "AlertsV2LessThanCondition": { "description": "Condition for less than alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionLessThan": { "type": "object", "properties": { "less_than": { "$ref": "#/components/schemas/AlertsV2LessThanCondition" } } }, "AlertsV1EvaluationWindow": { "example": "dynamic", "description": "The evaluation window for the alert condition", "type": "string", "enum": [ "rolling_or_unspecified", "dynamic" ] }, "AlertsV2MoreThanCondition": { "description": "Condition for more than alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" }, "evaluation_window": { "$ref": "#/components/schemas/AlertsV1EvaluationWindow" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionMoreThan": { "type": "object", "properties": { "more_than": { "$ref": "#/components/schemas/AlertsV2MoreThanCondition" } } }, "AlertsV2MoreThanUsualCondition": { "description": "Condition for more than usual alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionMoreThanUsual": { "type": "object", "properties": { "more_than_usual": { "$ref": "#/components/schemas/AlertsV2MoreThanUsualCondition" } } }, "AlertsV2NewValueCondition": { "description": "Condition for new value alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionNewValue": { "type": "object", "properties": { "new_value": { "$ref": "#/components/schemas/AlertsV2NewValueCondition" } } }, "AlertsV1FlowOperator": { "example": "or", "description": "Operator for the alerts", "type": "string", "enum": [ "and", "or" ] }, "AlertsV1FlowAlert": { "description": "List of alerts", "type": "object", "properties": { "id": { "example": "6ad87d32-1613-4cb1-b7e3-d97fee561913", "description": "The alert ID", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "not": { "example": true, "description": "The alert not", "type": "boolean" } } }, "AlertsV1FlowAlerts": { "description": "List of alerts", "type": "object", "properties": { "op": { "$ref": "#/components/schemas/AlertsV1FlowOperator" }, "values": { "description": "List of alerts", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1FlowAlert" }, "minItems": 0, "maxItems": 4096 } } }, "AlertsV1FlowGroup": { "description": "List of groups of alerts", "type": "object", "properties": { "alerts": { "$ref": "#/components/schemas/AlertsV1FlowAlerts" }, "next_op": { "$ref": "#/components/schemas/AlertsV1FlowOperator" } } }, "AlertsV1FlowTimeframe": { "description": "Timeframe for the flow", "type": "object", "properties": { "ms": { "example": 1000, "description": "Timeframe in milliseconds", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "AlertsV1FlowStage": { "description": "The Flow alert condition parameters", "type": "object", "properties": { "groups": { "description": "List of groups of alerts", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1FlowGroup" }, "minItems": 0, "maxItems": 4096 }, "timeframe": { "$ref": "#/components/schemas/AlertsV1FlowTimeframe" } } }, "AlertsV2FlowCondition": { "description": "Condition for flow alert", "type": "object", "properties": { "stages": { "description": "The Flow alert condition parameters", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1FlowStage" }, "minItems": 0, "maxItems": 50 }, "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" }, "enforce_suppression": { "example": true, "description": "Should suppression be enforced on the flow alert", "type": "boolean" } } }, "AlertsV2AlertConditionConditionFlow": { "type": "object", "properties": { "flow": { "$ref": "#/components/schemas/AlertsV2FlowCondition" } } }, "AlertsV2UniqueCountCondition": { "description": "Condition for unique count alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionUniqueCount": { "type": "object", "properties": { "unique_count": { "$ref": "#/components/schemas/AlertsV2UniqueCountCondition" } } }, "AlertsV2LessThanUsualCondition": { "description": "Condition for less than usual alert", "type": "object", "properties": { "parameters": { "$ref": "#/components/schemas/AlertsV2ConditionParameters" } }, "required": [ "parameters" ] }, "AlertsV2AlertConditionConditionLessThanUsual": { "type": "object", "properties": { "less_than_usual": { "$ref": "#/components/schemas/AlertsV2LessThanUsualCondition" } } }, "AlertsV2AlertCondition": { "description": "Alert condition", "oneOf": [ { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionImmediate" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionLessThan" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionMoreThan" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionMoreThanUsual" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionNewValue" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionFlow" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionUniqueCount" }, { "$ref": "#/components/schemas/AlertsV2AlertConditionConditionLessThanUsual" } ] }, "AlertsV2AlertNotificationIntegrationTypeIntegrationId": { "type": "object", "properties": { "integration_id": { "example": 123, "description": "Integration ID", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "AlertsV2Recipients": { "description": "Recipients", "type": "object", "properties": { "emails": { "example": [ "example@gmail.com" ], "description": "Email addresses", "type": "array", "items": { "description": "Email addresses", "type": "string", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 20 } } }, "AlertsV2AlertNotificationIntegrationTypeRecipients": { "type": "object", "properties": { "recipients": { "$ref": "#/components/schemas/AlertsV2Recipients" } } }, "AlertsV2NotifyOn": { "example": "triggered_and_resolved", "description": "Notify on setting", "type": "string", "enum": [ "triggered_only", "triggered_and_resolved" ] }, "AlertsV2AlertNotification": { "description": "Webhook target settings for the the notification", "properties": { "retriggering_period_seconds": { "example": 60, "description": "Retriggering period of the alert in seconds", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "notify_on": { "$ref": "#/components/schemas/AlertsV2NotifyOn" } }, "oneOf": [ { "$ref": "#/components/schemas/AlertsV2AlertNotificationIntegrationTypeIntegrationId" }, { "$ref": "#/components/schemas/AlertsV2AlertNotificationIntegrationTypeRecipients" } ] }, "AlertsV2AlertNotificationGroups": { "description": "Alert notification groups", "type": "object", "properties": { "group_by_fields": { "example": [ "cpu" ], "description": "Group by fields to group the values by", "type": "array", "items": { "description": "Group by fields to group the values by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 20 }, "notifications": { "description": "Webhook target settings for the the notification", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV2AlertNotification" }, "minItems": 0, "maxItems": 20 } } }, "AlertsV1AlertFiltersLogSeverity": { "example": "critical", "description": "The severity of the logs to filter", "type": "string", "enum": [ "debug_or_unspecified", "verbose", "info", "warning", "error", "critical" ] }, "AlertsV1AlertFiltersMetadataFilters": { "description": "The metadata filters", "type": "object", "properties": { "applications": { "example": [ "CpuMonitoring", "WebApi" ], "description": "The applications to filter", "type": "array", "items": { "description": "The applications to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 }, "subsystems": { "example": [ "SnapshotGenerator", "PermissionControl" ], "description": "The subsystems to filter", "type": "array", "items": { "description": "The subsystems to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 } } }, "AlertsV1AlertFiltersRatioAlert": { "description": "The ratio alerts", "type": "object", "properties": { "alias": { "example": "TopLevelAlert", "description": "The alias of the filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "text": { "example": "_exists_:\"container_name\"", "description": "The text to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "severities": { "description": "The severities to filter", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1AlertFiltersLogSeverity" }, "minItems": 0, "maxItems": 4096 }, "applications": { "example": [ "CpuMonitoring", "WebApi" ], "description": "The applications to filter", "type": "array", "items": { "description": "The applications to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 }, "subsystems": { "example": [ "SnapshotGenerator", "PermissionControl" ], "description": "The subsystems to filter", "type": "array", "items": { "description": "The subsystems to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 }, "group_by": { "example": [ "Host", "Thread" ], "description": "The group by fields", "type": "array", "items": { "description": "The group by fields", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 } }, "required": [ "alias" ] }, "AlertsV1AlertFiltersFilterType": { "example": "flow", "description": "The type of the filter", "type": "string", "enum": [ "text_or_unspecified", "template", "ratio", "unique_count", "time_relative", "metric", "flow" ] }, "AlertsV1AlertFilters": { "description": "Alert filters", "type": "object", "properties": { "severities": { "example": [ "critical" ], "description": "The severity of the logs to filter", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1AlertFiltersLogSeverity" }, "minItems": 0, "maxItems": 4096 }, "metadata": { "$ref": "#/components/schemas/AlertsV1AlertFiltersMetadataFilters" }, "alias": { "example": "monitorQuery", "description": "The alias of the filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "text": { "example": "_exists_:\"container_name\"", "description": "The text to filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "ratio_alerts": { "description": "The ratio alerts", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1AlertFiltersRatioAlert" }, "minItems": 0, "maxItems": 4096 }, "filter_type": { "$ref": "#/components/schemas/AlertsV1AlertFiltersFilterType" } } }, "AlertsV1DayOfWeek": { "example": "sunday", "description": "Days of the week for activity", "type": "string", "enum": [ "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "AlertsV1Time": { "description": "Start time", "type": "object", "properties": { "hours": { "example": 22, "description": "Hours of the day", "type": "integer", "format": "int32", "minimum": 0, "maximum": 24 }, "minutes": { "example": 22, "description": "Minutes of the hour", "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "seconds": { "example": 22, "description": "Seconds of the minute", "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 } } }, "AlertsV1TimeRange": { "description": "Time range in the day of the week", "type": "object", "properties": { "start": { "$ref": "#/components/schemas/AlertsV1Time" }, "end": { "$ref": "#/components/schemas/AlertsV1Time" } }, "required": [ "start", "end" ] }, "AlertsV1AlertActiveTimeframe": { "description": "Activity timeframes of the alert", "type": "object", "properties": { "days_of_week": { "example": [ "sunday" ], "description": "Days of the week for activity", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1DayOfWeek" }, "minItems": 1, "maxItems": 30 }, "range": { "$ref": "#/components/schemas/AlertsV1TimeRange" } }, "required": [ "days_of_week", "range" ] }, "AlertsV1AlertActiveWhen": { "description": "When will the alert be active", "type": "object", "properties": { "timeframes": { "description": "Activity timeframes of the alert", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1AlertActiveTimeframe" }, "minItems": 1, "maxItems": 30 } }, "required": [ "timeframes" ] }, "AlertsV1MetaLabel": { "description": "The Meta labels to add to the alert", "type": "object", "properties": { "key": { "example": "ColorLabel", "description": "The key of the label", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "value": { "example": "Red", "description": "The value of the label", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "AlertsV2AlertIncidentSettings": { "description": "Incident settings, will create the incident based on this configuration", "type": "object", "properties": { "retriggering_period_seconds": { "example": 60, "description": "The retriggering period of the alert in seconds", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "notify_on": { "$ref": "#/components/schemas/AlertsV2NotifyOn" }, "use_as_notification_settings": { "example": true, "description": "Use these settings for all notificaion webhook", "type": "boolean" } } }, "Alert": { "example": { "active_when": { "timeframes": [ { "days_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "range": { "end": { "hours": 18, "minutes": 29, "seconds": 59 }, "start": { "hours": 18, "minutes": 30 } } } ] }, "condition": { "more_than": { "evaluation_window": "rolling_or_unspecified", "parameters": { "group_by": [ "coralogix.metadata.applicationName" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 1, "timeframe": "timeframe_10_min" } } }, "description": "Alert when the number of logs reaches a threshold", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "severities": [ "info" ], "text": "initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create" }, "id": "4cc95bd2-81fa-4239-acfd-d2e8032bddc7", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 300, "use_as_notification_settings": true }, "is_active": true, "meta_labels": [ { "key": "env", "value": "dev" } ], "name": "Test alert", "notification_groups": [ { "group_by_fields": [ "coralogix.metadata.applicationName" ] } ], "severity": "info_or_unspecified", "unique_identifier": "a100339c-5b09-4fe7-9a3e-18745c377ce4" }, "description": "Alert resource model", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Alert ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Unique count alert", "description": "Alert name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Example of unique count alert from terraform", "description": "Alert description", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "is_active": { "example": true, "description": "Alert is active", "type": "boolean" }, "severity": { "$ref": "#/components/schemas/AlertsV1AlertSeverity" }, "expiration": { "$ref": "#/components/schemas/AlertsV1Date" }, "condition": { "$ref": "#/components/schemas/AlertsV2AlertCondition" }, "notification_groups": { "description": "Alert notification groups", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV2AlertNotificationGroups" }, "minItems": 1, "maxItems": 10 }, "filters": { "$ref": "#/components/schemas/AlertsV1AlertFilters" }, "active_when": { "$ref": "#/components/schemas/AlertsV1AlertActiveWhen" }, "notification_payload_filters": { "example": [ "message", "hostname" ], "description": "The JSON keys to be included in the alert notification. If unspecified, the full log text will be included in the alert notification.", "type": "array", "items": { "description": "The JSON keys to be included in the alert notification. If unspecified, the full log text will be included in the alert notification.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 }, "meta_labels": { "description": "The Meta labels to add to the alert", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1MetaLabel" }, "minItems": 0, "maxItems": 200 }, "meta_labels_strings": { "example": [ "env:dev" ], "description": "The meta data added to the alert as a string separated by a \":\" character.", "type": "array", "items": { "description": "The meta data added to the alert as a string separated by a \":\" character.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 2000 }, "minItems": 0, "maxItems": 4096 }, "unique_identifier": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Alert unique identifier", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "incident_settings": { "$ref": "#/components/schemas/AlertsV2AlertIncidentSettings" } }, "required": [ "id", "name", "is_active", "severity", "condition" ] }, "AlertCollection": { "example": { "alerts": [ { "active_when": { "timeframes": [ { "days_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "range": { "end": { "hours": 18, "minutes": 29, "seconds": 59 }, "start": { "hours": 18, "minutes": 30 } } } ] }, "condition": { "more_than": { "evaluation_window": "rolling_or_unspecified", "parameters": { "group_by": [ "coralogix.metadata.applicationName" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 1, "timeframe": "timeframe_10_min" } } }, "description": "Alert when the number of logs reaches a threshold", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "severities": [ "info" ], "text": "initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create" }, "id": "4cc95bd2-81fa-4239-acfd-d2e8032bddc7", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 300, "use_as_notification_settings": true }, "is_active": true, "meta_labels": [ { "key": "env", "value": "dev" } ], "name": "Test alert", "notification_groups": [ { "group_by_fields": [ "coralogix.metadata.applicationName" ] } ], "severity": "info_or_unspecified", "unique_identifier": "a100339c-5b09-4fe7-9a3e-18745c377ce4" }, { "active_when": { "timeframes": [ { "days_of_week": [ "thursday", "wednesday" ], "range": { "end": { "hours": 18, "minutes": 30 }, "start": { "hours": 6, "minutes": 30 } } } ] }, "condition": { "unique_count": { "parameters": { "cardinality_fields": [ "remote_addr_geoip.country_name" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 2, "timeframe": "timeframe_10_min" } } }, "description": "Example of unique count alert from terraform", "filters": { "filter_type": "unique_count", "metadata": {}, "severities": [ "info" ] }, "id": "5c334366-571a-4431-80ae-3086bf91c575", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 600, "use_as_notification_settings": false }, "is_active": true, "name": "Unique count alert example", "notification_groups": [ { "notifications": [ { "notify_on": "triggered_and_resolved", "recipients": { "emails": [ "example@coralogix.com" ] }, "retriggering_period_seconds": 60 } ] } ], "severity": "warning", "unique_identifier": "e6e01065-7eac-4f5f-8e24-2ee4c7122ab9" }, { "active_when": { "timeframes": [ { "days_of_week": [ "thursday", "wednesday" ], "range": { "end": { "hours": 18, "minutes": 30 }, "start": { "hours": 6, "minutes": 30 } } } ] }, "condition": { "unique_count": { "parameters": { "cardinality_fields": [ "remote_addr_geoip.country_name" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 2, "timeframe": "timeframe_10_min" } } }, "description": "Example of unique count alert from terraform", "filters": { "filter_type": "unique_count", "metadata": {}, "severities": [ "info" ] }, "id": "ffea3734-56eb-4f25-a59a-2d9889c71f46", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 600, "use_as_notification_settings": false }, "is_active": true, "name": "Unique count alert example", "notification_groups": [ { "notifications": [ { "notify_on": "triggered_and_resolved", "recipients": { "emails": [ "example@coralogix.com" ] }, "retriggering_period_seconds": 60 } ] } ], "severity": "info_or_unspecified", "unique_identifier": "39246ad5-19a0-43fd-aa76-e6ff075e864b" }, { "condition": { "more_than_usual": { "parameters": { "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 10, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "OKTA audit extension pack", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "text": "legacyEventType:\\\"login failed\\\"" }, "id": "b2f843d7-4721-4ce2-ac0d-ea0443bbe372", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 60, "use_as_notification_settings": false }, "is_active": true, "name": "More than usual login failures", "notification_groups": [ {} ], "severity": "info_or_unspecified", "show_in_insight": { "notify_on": "triggered_only", "retriggering_period_seconds": 60 }, "unique_identifier": "4fa3710a-c91d-4d6e-8359-41a44c45a141" }, { "condition": { "more_than_usual": { "parameters": { "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 10, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "OKTA audit extension pack", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "text": "legacyEventType:\\\"login failed\\\"" }, "id": "1a02193d-856b-4f84-ab4e-9918ac136244", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 60, "use_as_notification_settings": false }, "is_active": true, "name": "More than usual login failures", "notification_groups": [ {} ], "severity": "info_or_unspecified", "show_in_insight": { "notify_on": "triggered_only", "retriggering_period_seconds": 60 }, "unique_identifier": "bd851dfb-2aa4-4ed7-97ec-922f01f98036" }, { "active_when": { "timeframes": [ { "days_of_week": [ "thursday", "wednesday" ], "range": { "end": { "hours": 18, "minutes": 30 }, "start": { "hours": 6, "minutes": 30 } } } ] }, "condition": { "unique_count": { "parameters": { "cardinality_fields": [ "remote_addr_geoip.country_name" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 2, "timeframe": "timeframe_10_min" } } }, "description": "Example of unique count alert from terraform", "filters": { "filter_type": "unique_count", "metadata": {}, "severities": [ "info" ] }, "id": "29f24d53-f219-4245-a2b9-009e98bd8c4e", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 600, "use_as_notification_settings": false }, "is_active": true, "name": "Unique count alert example", "notification_groups": [ { "notifications": [ { "notify_on": "triggered_and_resolved", "recipients": { "emails": [ "example@coralogix.com" ] }, "retriggering_period_seconds": 60 } ] } ], "severity": "info_or_unspecified", "unique_identifier": "e09735d3-a472-4df7-9d2c-2bfe851c436e" }, { "active_when": { "timeframes": [ { "days_of_week": [ "thursday", "wednesday" ], "range": { "end": { "hours": 18, "minutes": 30 }, "start": { "hours": 6, "minutes": 30 } } } ] }, "condition": { "unique_count": { "parameters": { "cardinality_fields": [ "remote_addr_geoip.country_name" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 2, "timeframe": "timeframe_10_min" } } }, "description": "Example of unique count alert from terraform", "filters": { "filter_type": "unique_count", "metadata": {}, "severities": [ "info" ] }, "id": "3d57bc5b-28b3-4ffe-9ece-049457760edc", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 600, "use_as_notification_settings": false }, "is_active": true, "name": "Unique count alert example", "notification_groups": [ { "notifications": [ { "notify_on": "triggered_and_resolved", "recipients": { "emails": [ "example@coralogix.com" ] }, "retriggering_period_seconds": 60 } ] } ], "severity": "info_or_unspecified", "unique_identifier": "f6f8d470-7793-44d2-82ef-34f95f01b8fa" }, { "active_when": { "timeframes": [ { "days_of_week": [ "monday_or_unspecified", "wednesday" ], "range": { "end": { "hours": 18, "minutes": 30 }, "start": { "hours": 6, "minutes": 30 } } } ] }, "condition": { "unique_count": { "parameters": { "cardinality_fields": [ "remote_addr_geoip.country_name" ], "ignore_infinity": true, "relative_timeframe": "hour_or_unspecified", "threshold": 2, "timeframe": "timeframe_10_min" } } }, "description": "Example of unique count alert from terraform", "filters": { "filter_type": "unique_count", "metadata": {}, "severities": [ "info" ] }, "id": "861320bc-33a1-4dfc-9180-0d0afecb68de", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 600, "use_as_notification_settings": false }, "is_active": true, "name": "Unique count alert example", "notification_groups": [ { "notifications": [ { "notify_on": "triggered_and_resolved", "recipients": { "emails": [ "example@coralogix.com" ] }, "retriggering_period_seconds": 60 } ] } ], "severity": "info_or_unspecified", "unique_identifier": "06facfcf-dfdd-49b0-8078-a07448d0cd54" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "060f9814-f7fe-4955-96fd-2c6e790a391b", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 112", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "1ccd73dc-eb4b-437b-b2c1-273457b03424" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "70b27d7d-0c54-4f2f-8254-a9a828571fe9", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "934260b6-cfcd-463a-b25f-54015411df6c" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "4c2132ca-2f2e-4ea5-8089-810ffad38f82", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "f98c3d0e-9ed0-4b0d-a8c4-698ecbfd3c1c" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "ba301f45-c955-4cef-b8b7-fae3d4da26d6", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "258464d8-e26b-4ecb-8b58-07138fe2b44d" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "a32c5827-d31d-4699-8701-c14d905d007b", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "37368b5b-c5e7-4670-9902-8a70cca08a56" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "64971da5-a32a-4310-9137-e07ee4d549ab", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "c757edc0-ff3a-4dd8-af7a-b06a9feab84d" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "6b6c9073-94c5-4c43-984d-71e29e6025ba", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "243ad4d6-ad2e-4c5d-8f12-712d3a089912" }, { "active_when": {}, "condition": { "more_than_usual": { "parameters": { "group_by": [ "access_mode" ], "ignore_infinity": true, "metric_alert_promql_parameters": { "non_null_percentage": 10, "promql_text": "sum(_firehose_processing_error_count_created) by (access_mode)", "sample_threshold_percentage": 20, "swap_null_values": false }, "relative_timeframe": "hour_or_unspecified", "threshold": 0, "timeframe": "timeframe_5_min_or_unspecified" } } }, "description": "asd", "filters": { "filter_type": "metric", "metadata": {} }, "id": "002822dd-361d-48c6-b5d2-8f4bfcbdf9da", "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 900, "use_as_notification_settings": true }, "is_active": false, "name": "test more than usual 12", "notification_groups": [ {} ], "severity": "info_or_unspecified", "unique_identifier": "d0a39163-dc38-4ae4-a62b-af51362c916d" } ] }, "description": "Alerts collection", "type": "object", "properties": { "alerts": { "description": "Alerts", "type": "array", "items": { "$ref": "#/components/schemas/Alert" }, "minItems": 0, "maxItems": 4096 } } }, "AlertPrototype": { "example": { "active_when": { "timeframes": [ { "days_of_week": [ "sunday", "monday_or_unspecified", "tuesday", "wednesday", "thursday", "friday", "saturday" ], "range": { "end": { "hours": 18, "minutes": 29, "seconds": 59 }, "start": { "hours": 18, "minutes": 30, "seconds": 0 } } } ] }, "condition": { "more_than": { "evaluation_window": "rolling_or_unspecified", "parameters": { "cardinality_fields": [], "group_by": [ "coralogix.metadata.applicationName" ], "ignore_infinity": true, "notify_group_by_only_alerts": true, "relative_timeframe": "hour_or_unspecified", "threshold": 1, "timeframe": "timeframe_10_min" } } }, "description": "Alert when the number of logs reaches a threshold", "filters": { "filter_type": "text_or_unspecified", "metadata": {}, "ratio_alerts": [], "severities": [ "info" ], "text": "initiator.id.keyword:iam-ServiceId-10820fd6-c3fe-414e-8fd5-44ce95f7d34d AND action.keyword:cloud-object-storage.object.create" }, "incident_settings": { "notify_on": "triggered_only", "retriggering_period_seconds": 300, "use_as_notification_settings": true }, "is_active": true, "meta_labels": [ { "key": "env", "value": "dev" } ], "meta_labels_strings": [], "name": "Test alert", "notification_groups": [ { "group_by_fields": [ "coralogix.metadata.applicationName" ], "notifications": [] } ], "severity": "info_or_unspecified" }, "description": "Request body used to create or update an alert", "type": "object", "properties": { "name": { "example": "Unique count alert", "description": "Alert name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Example of unique count alert from terraform", "description": "Alert description", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "is_active": { "example": true, "description": "Alert is active", "type": "boolean" }, "severity": { "$ref": "#/components/schemas/AlertsV1AlertSeverity" }, "expiration": { "$ref": "#/components/schemas/AlertsV1Date" }, "condition": { "$ref": "#/components/schemas/AlertsV2AlertCondition" }, "notification_groups": { "description": "Alert notification groups", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV2AlertNotificationGroups" }, "minItems": 1, "maxItems": 10 }, "filters": { "$ref": "#/components/schemas/AlertsV1AlertFilters" }, "active_when": { "$ref": "#/components/schemas/AlertsV1AlertActiveWhen" }, "notification_payload_filters": { "example": [ "id", "name" ], "description": "The JSON keys to be included in the alert notification. If unspecified, the full log text will be included in the alert notification.", "type": "array", "items": { "description": "The JSON keys to be included in the alert notification. If unspecified, the full log text will be included in the alert notification.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 100 }, "meta_labels": { "description": "The Meta labels to add to the alert", "type": "array", "items": { "$ref": "#/components/schemas/AlertsV1MetaLabel" }, "minItems": 0, "maxItems": 200 }, "meta_labels_strings": { "example": [ "env:dev" ], "description": "The meta data added to the alert as a string separated by a \":\" character.", "type": "array", "items": { "description": "The meta data added to the alert as a string separated by a \":\" character.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 2000 }, "minItems": 0, "maxItems": 4096 }, "incident_settings": { "$ref": "#/components/schemas/AlertsV2AlertIncidentSettings" } }, "required": [ "name", "is_active", "severity", "condition" ] }, "ApisDataprimeV1QuerySyntax": { "example": "dataprime_utf8_base64", "description": "The query syntax", "type": "string", "enum": [ "unspecified", "lucene", "dataprime", "lucene_utf8_base64", "dataprime_utf8_base64" ] }, "ApisDataprimeV1DataprimeResultsKeyValue": { "description": "Metadata of the result", "type": "object", "properties": { "key": { "example": "subsystemname", "description": "Key of the result", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "value": { "example": "agent", "description": "Value of the result", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "key", "value" ] }, "ApisDataprimeV1DataprimeResults": { "description": "Results of the query", "type": "object", "properties": { "metadata": { "description": "Metadata of the result", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeResultsKeyValue" }, "minItems": 0, "maxItems": 4096 }, "labels": { "description": "Labels of the result", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeResultsKeyValue" }, "minItems": 0, "maxItems": 4096 }, "user_data": { "example": "{\"text\":\"event1\"}", "description": "Data of the result", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "user_data" ] }, "ApisDataprimeV1DataprimeResult": { "description": "Result message", "type": "object", "properties": { "results": { "description": "Results of the query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeResults" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDataprimeV1CompileWarning": { "description": "Warning from Dataprime compilation", "type": "object", "properties": { "warning_message": { "example": "keypath does not exist '$d.foo' in line 0 at column 21", "description": "Warning message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "warning_message" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeCompileWarning": { "type": "object", "properties": { "compile_warning": { "$ref": "#/components/schemas/ApisDataprimeV1CompileWarning" } } }, "ApisDataprimeV1TimeRangeWarning": { "description": "Warning from applying a time range to the query", "type": "object", "properties": { "warning_message": { "example": "end of time range is set to: 2024-03-10 15:00:00.000", "description": "Warning message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "start_date": { "example": "2021-01-01T00:00:00.000Z", "description": "Start date of the time range", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "end_date": { "example": "2021-01-01T00:00:00.000Z", "description": "End date of the time range", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } }, "required": [ "warning_message" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeTimeRangeWarning": { "type": "object", "properties": { "time_range_warning": { "$ref": "#/components/schemas/ApisDataprimeV1TimeRangeWarning" } } }, "ApisDataprimeV1NumberOfResultsLimitWarning": { "description": "Warning from applying a limit on the number of results", "type": "object", "properties": { "number_of_results_limit": { "example": 10000, "description": "Warning message", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "number_of_results_limit" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeNumberOfResultsLimitWarning": { "type": "object", "properties": { "number_of_results_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1NumberOfResultsLimitWarning" } } }, "ApisDataprimeV1BytesScannedLimitWarningEmpty": { "description": "Warning for reaching the bytes scanned limit", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeBytesScannedLimitWarning": { "type": "object", "properties": { "bytes_scanned_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1BytesScannedLimitWarningEmpty" } } }, "ApisDataprimeV1DeprecationWarning": { "description": "Warning about deprecated elements", "type": "object", "properties": { "warning_message": { "example": "Deprecated value 'TIER_FREQUENT_SEARCH_UNSPECIFIED' used. Use 'TIER_FREQUENT_SEARCH' instead", "description": "Warning message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "warning_message" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeDeprecationWarning": { "type": "object", "properties": { "deprecation_warning": { "$ref": "#/components/schemas/ApisDataprimeV1DeprecationWarning" } } }, "ApisDataprimeV1BlocksLimitWarningEmpty": { "description": "Warning when the query has reached the maximum number of parquet blocks", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeBlocksLimitWarning": { "type": "object", "properties": { "blocks_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1BlocksLimitWarningEmpty" } } }, "ApisDataprimeV1AggregationBucketsLimitWarning": { "description": "Warning for reaching the aggregation buckets limit", "type": "object", "properties": { "aggregation_buckets_limit": { "example": 100, "description": "Limit of aggregation buckets", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "aggregation_buckets_limit" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeAggregationBucketsLimitWarning": { "type": "object", "properties": { "aggregation_buckets_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1AggregationBucketsLimitWarning" } } }, "ApisDataprimeV1ArchiveWarningNoMetastoreDataEmpty": { "type": "object" }, "ApisDataprimeV1ArchiveWarningWarningTypeNoMetastoreData": { "type": "object", "properties": { "no_metastore_data": { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningNoMetastoreDataEmpty" } } }, "ApisDataprimeV1ArchiveWarningBucketAccessDeniedEmpty": { "type": "object" }, "ApisDataprimeV1ArchiveWarningWarningTypeBucketAccessDenied": { "type": "object", "properties": { "bucket_access_denied": { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningBucketAccessDeniedEmpty" } } }, "ApisDataprimeV1ArchiveWarningBucketReadFailedEmpty": { "type": "object" }, "ApisDataprimeV1ArchiveWarningWarningTypeBucketReadFailed": { "type": "object", "properties": { "bucket_read_failed": { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningBucketReadFailedEmpty" } } }, "ApisDataprimeV1ArchiveWarningMissingDataEmpty": { "type": "object" }, "ApisDataprimeV1ArchiveWarningWarningTypeMissingData": { "type": "object", "properties": { "missing_data": { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningMissingDataEmpty" } } }, "ApisDataprimeV1ArchiveWarning": { "description": "Wrapper for archive related warnings", "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningWarningTypeNoMetastoreData" }, { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningWarningTypeBucketAccessDenied" }, { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningWarningTypeBucketReadFailed" }, { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarningWarningTypeMissingData" } ] }, "ApisDataprimeV1DataprimeWarningWarningTypeArchiveWarning": { "type": "object", "properties": { "archive_warning": { "$ref": "#/components/schemas/ApisDataprimeV1ArchiveWarning" } } }, "ApisDataprimeV1ScrollTimeoutWarningEmpty": { "description": "Warning when OpenSearch scroll timeout is reached", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeScrollTimeoutWarning": { "type": "object", "properties": { "scroll_timeout_warning": { "$ref": "#/components/schemas/ApisDataprimeV1ScrollTimeoutWarningEmpty" } } }, "ApisDataprimeV1FieldCountLimitWarningEmpty": { "description": "Warning when the result contains entries where the number of fields is truncated", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeFieldCountLimitWarning": { "type": "object", "properties": { "field_count_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1FieldCountLimitWarningEmpty" } } }, "ApisDataprimeV1ShuffleFileSizeLimitReachedWarningEmpty": { "description": "Warning when the shuffle file size limit is reached - For example during a join with a large right side", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeShuffleFileSizeLimitReachedWarning": { "type": "object", "properties": { "shuffle_file_size_limit_reached_warning": { "$ref": "#/components/schemas/ApisDataprimeV1ShuffleFileSizeLimitReachedWarningEmpty" } } }, "ApisDataprimeV1FilesReadLimitWarningEmpty": { "description": "Batch of results\n warning when the query has reached maximum number of parquet files", "type": "object" }, "ApisDataprimeV1DataprimeWarningWarningTypeFilesReadLimitWarning": { "type": "object", "properties": { "files_read_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1FilesReadLimitWarningEmpty" } } }, "ApisDataprimeV1SidebarFilterCardinalityLimitWarning": { "description": "Warning when a field has reached the cardinality limit", "type": "object", "properties": { "fields": { "example": [ "subsystemname" ], "description": "List of fields that have reached the cardinality limit", "type": "array", "items": { "description": "List of fields that have reached the cardinality limit", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "cardinality_limit": { "example": 100, "description": "Cardinality limit\nThis is the limit for the number of unique values in a field. If the number of unique values in a field is greater than this limit, the field will be excluded from the results. This is a warning and not an error. The query will still run.", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 } }, "required": [ "fields", "cardinality_limit" ] }, "ApisDataprimeV1DataprimeWarningWarningTypeSidebarFilterCardinalityLimitWarning": { "type": "object", "properties": { "sidebar_filter_cardinality_limit_warning": { "$ref": "#/components/schemas/ApisDataprimeV1SidebarFilterCardinalityLimitWarning" } } }, "ApisDataprimeV1DataprimeWarning": { "description": "Warning message", "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeCompileWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeTimeRangeWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeNumberOfResultsLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeBytesScannedLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeDeprecationWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeBlocksLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeAggregationBucketsLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeArchiveWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeScrollTimeoutWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeFieldCountLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeShuffleFileSizeLimitReachedWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeFilesReadLimitWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarningWarningTypeSidebarFilterCardinalityLimitWarning" } ] }, "BackgroundQueryPrototype": { "description": "Submit a background query to be processed asynchronously.", "type": "object", "properties": { "query": { "example": "source logs | filter $d.apiVersion == 42", "description": "The background query to be run.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "syntax": { "$ref": "#/components/schemas/ApisDataprimeV1QuerySyntax" }, "start_date": { "example": "2023-11-05T13:15:30.000Z", "description": "Beginning of the time range for the query, default: end - 15 minutes or current\n time - 15 minutes if end is not defined.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "end_date": { "example": "2023-11-05T13:15:30.000Z", "description": "End of the time range for the query. Default: start + 15 minutes or current\n time if start is not defined", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "now_date": { "example": "2023-11-05T13:15:30.000Z", "description": "Contextual `now` for the query, default: current time. Used by functions\n like now() in DataPrime.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } }, "required": [ "query", "syntax" ] }, "BackgroundQuery": { "description": "Background query response", "type": "object", "properties": { "query_id": { "example": "412036c3-04be-431a-b1e2-9ebf971be6c6", "description": "Generated query ID that can be used to obtain the status and results of a background query.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "warnings": { "description": "All warnings that can be issued when a query is run.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarning" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "query_id", "warnings" ] }, "ApisDataprimeV1GetBackgroundQueryStatusResponseRunning": { "description": "The query is still running", "type": "object", "properties": { "running_since": { "example": "2021-01-01T00:00:00.000Z", "description": "The query has been running since this time", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseStatusRunning": { "type": "object", "properties": { "running": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseRunning" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedSuccessEmpty": { "description": "The query has been terminated successfully", "type": "object" }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusSuccess": { "type": "object", "properties": { "success": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedSuccessEmpty" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorTimedOutEmpty": { "description": "The query has been terminated due to a timeout", "type": "object" }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorTimedOut": { "type": "object", "properties": { "timed_out": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorTimedOutEmpty" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorCancelledEmpty": { "description": "The query has been terminated due to a cancellation", "type": "object" }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorCancelled": { "type": "object", "properties": { "cancelled": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorCancelledEmpty" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorFailed": { "description": "The query has been terminated due to a failure", "type": "object", "properties": { "reason": { "example": "Failed to run the query 1/archive/3424/4rwoNx1XNcc", "description": "The reason for the failure", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "reason" ] }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorFailed": { "type": "object", "properties": { "failed": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorFailed" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedError": { "description": "The query has been terminated with an error", "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorTimedOut" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorCancelled" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedErrorErrorFailed" } ] }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedError" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedCancelledEmpty": { "description": "The query has been cancelled", "type": "object" }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusCancelled": { "type": "object", "properties": { "cancelled": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedCancelledEmpty" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseTerminated": { "description": "The query has been terminated", "properties": { "running_since": { "example": "2021-01-01T00:00:00.000Z", "description": "The query was terminated at this time.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "terminated_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The query was terminated at this time.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } }, "required": [ "running_since", "terminated_at" ], "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusSuccess" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusError" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminatedStatusCancelled" } ] }, "ApisDataprimeV1GetBackgroundQueryStatusResponseStatusTerminated": { "type": "object", "properties": { "terminated": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseTerminated" } } }, "ApisDataprimeV1GetBackgroundQueryStatusResponseWaitingForExecutionEmpty": { "type": "object" }, "ApisDataprimeV1GetBackgroundQueryStatusResponseStatusWaitingForExecution": { "type": "object", "properties": { "waiting_for_execution": { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseWaitingForExecutionEmpty" } } }, "ApisDataprimeV1ResponseMetadataStatistics": { "type": "object", "properties": { "bytes_scanned": { "example": 1000000, "description": "Number of bytes scanned by the query", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 } }, "required": [ "bytes_scanned" ] }, "ApisDataprimeV1ResponseMetadata": { "description": "Does not contain duplicate messages", "type": "object", "properties": { "statistics": { "$ref": "#/components/schemas/ApisDataprimeV1ResponseMetadataStatistics" } } }, "BackgroundQueryStatus": { "description": "The status of a background query", "properties": { "submitted_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The query has been submitted", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "metadata": { "description": "Does not contain duplicate messages", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1ResponseMetadata" }, "minItems": 0, "maxItems": 4096 }, "warnings": { "description": "Includes all warnings (For example: warnings that can apprear during query\n submission + runtime warnings)", "type": "array", "items": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarning" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "submitted_at", "metadata", "warnings" ], "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseStatusRunning" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseStatusTerminated" }, { "$ref": "#/components/schemas/ApisDataprimeV1GetBackgroundQueryStatusResponseStatusWaitingForExecution" } ] }, "ApisDataprimeV1GetDataResponse": { "type": "object", "properties": { "results": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeResult" } }, "required": [ "results" ] }, "GetBackgroundQueryDataResponse": { "description": "Response structure of background query data.", "type": "object", "properties": { "response": { "$ref": "#/components/schemas/ApisDataprimeV1GetDataResponse" } }, "required": [ "response" ] }, "ApisDataprimeV1GetBackgroundQueryDataResponseStreamItem": { "oneOf": [ { "$ref": "#/components/schemas/GetBackgroundQueryDataResponse" }, { "$ref": "#/components/schemas/ApiError" } ] }, "ApisDashboardsV1CommonTimeFrame": { "description": "The fixed start and end absolute time frame", "type": "object", "properties": { "from": { "example": "2021-01-01T00:00:00.000Z", "description": "From is the start of the time frame", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "to": { "example": "2021-01-01T00:00:00.000Z", "description": "To is the end of the time frame", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } } }, "ApisDashboardsV1AstDashboardTimeFrameAbsoluteTimeFrame": { "type": "object", "properties": { "absolute_time_frame": { "$ref": "#/components/schemas/ApisDashboardsV1CommonTimeFrame" } } }, "ApisDashboardsV1AstDashboardTimeFrameRelativeTimeFrame": { "type": "object", "properties": { "relative_time_frame": { "example": "1d", "description": "Relative time frame specifying a duration from the current time.", "type": "string", "pattern": "^[0-9]+[smhdw]?$", "minLength": 2, "maxLength": 10 } } }, "ApisDashboardsV1Uuid": { "description": "Unique identifier of the folder containing the dashboard.", "type": "object", "properties": { "value": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The UUID value", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "value" ] }, "ApisDashboardsV1AstDashboardFolderFolderId": { "type": "object", "properties": { "folder_id": { "$ref": "#/components/schemas/ApisDashboardsV1Uuid" } } }, "ApisDashboardsV1AstFolderPath": { "description": "Path of the folder containing the dashboard.", "type": "object", "properties": { "segments": { "example": [ "production", "payments" ], "description": "The segments of the folder path.", "type": "array", "items": { "description": "The segments of the folder path.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstDashboardFolderFolderPath": { "type": "object", "properties": { "folder_path": { "$ref": "#/components/schemas/ApisDashboardsV1AstFolderPath" } } }, "ApisDashboardsV1AstDashboardAutoRefreshOffEmpty": { "description": "Auto refresh interval is set to off.", "type": "object" }, "ApisDashboardsV1AstDashboardAutoRefreshOff": { "type": "object", "properties": { "off": { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshOffEmpty" } } }, "ApisDashboardsV1AstDashboardAutoRefreshTwoMinutesEmpty": { "description": "Auto refresh interval is set to two minutes.", "type": "object" }, "ApisDashboardsV1AstDashboardAutoRefreshTwoMinutes": { "type": "object", "properties": { "two_minutes": { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshTwoMinutesEmpty" } } }, "ApisDashboardsV1AstDashboardAutoRefreshFiveMinutesEmpty": { "description": "Auto refresh interval is set to five minutes.", "type": "object" }, "ApisDashboardsV1AstDashboardAutoRefreshFiveMinutes": { "type": "object", "properties": { "five_minutes": { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshFiveMinutesEmpty" } } }, "ApisDashboardsV1AstRowAppearance": { "description": "The appearance of the row, such as height", "type": "object", "properties": { "height": { "example": 5, "description": "The height of the row", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "height" ] }, "ApisDashboardsV1AstWidgetsCommonLegendLegendColumn": { "example": "name", "description": "The columns to show in the legend", "type": "string", "enum": [ "unspecified", "min", "max", "sum", "avg", "last", "name" ] }, "ApisDashboardsV1AstWidgetsCommonLegend": { "description": "Legend configuration", "type": "object", "properties": { "is_visible": { "example": true, "description": "Whether to show the legend or not", "type": "boolean" }, "columns": { "example": [ "name" ], "description": "The columns to show in the legend", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLegendLegendColumn" }, "minItems": 0, "maxItems": 4096 }, "group_by_query": { "example": true, "description": "Whether to group by the query or not", "type": "boolean" } }, "required": [ "is_visible", "group_by_query" ] }, "ApisDashboardsV1AstWidgetsLineChartTooltipType": { "example": "single", "description": "Tooltip type", "type": "string", "enum": [ "unspecified", "all", "single" ] }, "ApisDashboardsV1AstWidgetsLineChartTooltip": { "description": "Tooltip configuration", "type": "object", "properties": { "show_labels": { "example": true, "description": "Whether to show labels in the tooltip", "type": "boolean" }, "type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartTooltipType" } } }, "ApisDashboardsV1AstWidgetsCommonLuceneQuery": { "description": "Lucene query", "type": "object", "properties": { "value": { "example": "coralogix.metadata.applicationName:\"production\"", "description": "The query string", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1CommonLogsAggregationCountEmpty": { "description": "Count the number of entries", "type": "object" }, "ApisDashboardsV1CommonLogsAggregationValueCount": { "type": "object", "properties": { "count": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationCountEmpty" } } }, "ApisDashboardsV1CommonDatasetScope": { "example": "metadata", "description": "Scope of the dataset", "type": "string", "enum": [ "unspecified", "user_data", "label", "metadata" ] }, "ApisDashboardsV1CommonObservationField": { "description": "Count the distinct values of the specified field", "type": "object", "properties": { "keypath": { "example": [ "applicationname" ], "description": "Path within the dataset scope", "type": "array", "items": { "description": "Path within the dataset scope", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 4096 }, "scope": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDatasetScope" } } }, "ApisDashboardsV1CommonLogsAggregationCountDistinct": { "description": "Count the number of distinct values of the log field", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValueCountDistinct": { "type": "object", "properties": { "count_distinct": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationCountDistinct" } } }, "ApisDashboardsV1CommonLogsAggregationSum": { "description": "Sum values of the log field", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValueSum": { "type": "object", "properties": { "sum": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationSum" } } }, "ApisDashboardsV1CommonLogsAggregationAverage": { "description": "Calculate average value of the log field", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValueAverage": { "type": "object", "properties": { "average": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationAverage" } } }, "ApisDashboardsV1CommonLogsAggregationMin": { "description": "Calculate the minimum value of the log field", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValueMin": { "type": "object", "properties": { "min": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationMin" } } }, "ApisDashboardsV1CommonLogsAggregationMax": { "description": "Calculate maximum value of the log field", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValueMax": { "type": "object", "properties": { "max": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationMax" } } }, "ApisDashboardsV1CommonLogsAggregationPercentile": { "description": "Calculate percentile value of the log field", "type": "object", "properties": { "percent": { "description": "Value in range (0, 100]", "type": "number", "format": "double" }, "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "percent", "observation_field" ] }, "ApisDashboardsV1CommonLogsAggregationValuePercentile": { "type": "object", "properties": { "percentile": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationPercentile" } } }, "ApisDashboardsV1CommonLogsAggregation": { "description": "Aggregations", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueCount" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueCountDistinct" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueSum" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueAverage" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueMin" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValueMax" }, { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregationValuePercentile" } ] }, "ApisDashboardsV1AstFilterEqualsSelectionAllSelectionEmpty": { "description": "Represents a selection of all values.", "type": "object" }, "ApisDashboardsV1AstFilterEqualsSelectionValueAll": { "type": "object", "properties": { "all": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEqualsSelectionAllSelectionEmpty" } } }, "ApisDashboardsV1AstFilterEqualsSelectionListSelection": { "description": "Represents a selection from a list of values.", "type": "object", "properties": { "values": { "description": "List of values for the selection.", "type": "array", "items": { "description": "List of values for the selection.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstFilterEqualsSelectionValueList": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEqualsSelectionListSelection" } } }, "ApisDashboardsV1AstFilterEqualsSelection": { "description": "Selection criteria for the equality comparison.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEqualsSelectionValueAll" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEqualsSelectionValueList" } ] }, "ApisDashboardsV1AstFilterEquals": { "description": "Equality comparison.", "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEqualsSelection" } } }, "ApisDashboardsV1AstFilterOperatorValueEquals": { "type": "object", "properties": { "equals": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterEquals" } } }, "ApisDashboardsV1AstFilterNotEqualsSelectionListSelection": { "description": "Represents a selection from a list of values.", "type": "object", "properties": { "values": { "description": "List of values for the selection.", "type": "array", "items": { "description": "List of values for the selection.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstFilterNotEqualsSelection": { "description": "Selection criteria for the non-equality comparison.", "type": "object", "properties": { "list": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterNotEqualsSelectionListSelection" } } }, "ApisDashboardsV1AstFilterNotEquals": { "description": "Non-equality comparison.", "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterNotEqualsSelection" } } }, "ApisDashboardsV1AstFilterOperatorValueNotEquals": { "type": "object", "properties": { "not_equals": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterNotEquals" } } }, "ApisDashboardsV1AstFilterOperator": { "description": "Operator to use for filtering the logs.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterOperatorValueEquals" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterOperatorValueNotEquals" } ] }, "ApisDashboardsV1AstFilterLogsFilter": { "description": "Additional filtering done in addition to the Lucene query", "type": "object", "properties": { "operator": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterOperator" }, "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } } }, "ApisDashboardsV1AstWidgetsLineChartLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "group_by": { "description": "Group by fields (deprecated)", "type": "array", "items": { "description": "Group by fields (deprecated)", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "aggregations": { "description": "Aggregations", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" }, "minItems": 0, "maxItems": 4096 }, "filters": { "description": "Additional filtering done in addition to the Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_bys": { "description": "Group by fields", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstWidgetsLineChartQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartLogsQuery" } } }, "ApisDashboardsV1AstWidgetsCommonPromQlQuery": { "description": "PromQL query", "type": "object", "properties": { "value": { "example": "sum(up)", "description": "The query string", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstFilterMetricsFilter": { "description": "Filtering to be applied to query results", "type": "object", "properties": { "label": { "example": "service", "description": "Label associated with the metric.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "operator": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterOperator" } } }, "ApisDashboardsV1AstWidgetsLineChartMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "filters": { "description": "Filtering to be applied to query results", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstWidgetsLineChartQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartMetricsQuery" } } }, "ApisDashboardsV1CommonDataprimeQuery": { "description": "Dataprime query", "type": "object", "properties": { "text": { "example": "source logs", "description": "The query string.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstFilterSourceValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" } } }, "ApisDashboardsV1AstFilterSourceValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" } } }, "ApisDashboardsV1AstFilterSource": { "description": "Filters to be applied to the query results", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSourceValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSourceValueMetrics" } ] }, "ApisDashboardsV1AstWidgetsLineChartDataprimeQuery": { "description": "Dataprime language based query", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Filters to be applied to the query results", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "dataprime_query" ] }, "ApisDashboardsV1AstWidgetsLineChartQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsLineChartQuery": { "description": "Data source-specific query. This query defines where and how the data is fetched.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsCommonUnit": { "example": "usd", "description": "The unit type of the data", "type": "string", "enum": [ "unspecified", "microseconds", "milliseconds", "seconds", "bytes", "kbytes", "mbytes", "gbytes", "bytes_iec", "kibytes", "mibytes", "gibytes", "eur_cents", "eur", "usd_cents", "usd" ] }, "ApisDashboardsV1AstWidgetsCommonScaleType": { "example": "logarithmic", "description": "Scale type", "type": "string", "enum": [ "unspecified", "linear", "logarithmic" ] }, "ApisDashboardsV1AstWidgetsLineChartResolution": { "description": "Resolution of the data", "type": "object", "properties": { "interval": { "example": "1m", "description": "Interval between data points", "type": "string", "pattern": "^[0-9]+[smhdw]?$", "minLength": 2, "maxLength": 10 }, "buckets_presented": { "example": 100, "description": "Maximum number of data points to fetch", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } }, "ApisDashboardsV1AstWidgetsCommonDataModeType": { "example": "archive", "description": "Data mode type", "type": "string", "enum": [ "high_unspecified", "archive" ] }, "ApisDashboardsV1AstWidgetsLineChartQueryDefinition": { "description": "Query definitions", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Unique identifier of the query within the widget", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartQuery" }, "series_name_template": { "example": "{{severity}}", "description": "The template for the series name in the legend and the tooltip", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "series_count_limit": { "example": "10", "description": "Maximum number of series to display", "type": "string", "pattern": "^-?\\d{1,19}$", "minLength": 1, "maxLength": 19 }, "unit": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonUnit" }, "scale_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonScaleType" }, "name": { "example": "CPU usage", "description": "Query name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "is_visible": { "example": true, "description": "Whether data for this query will be visible on the chart", "type": "boolean" }, "color_scheme": { "example": "classic", "description": "Color scheme for the series", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "resolution": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartResolution" }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" } }, "required": [ "id", "query", "is_visible", "resolution" ] }, "ApisDashboardsV1AstWidgetsLineChartStackedLine": { "example": "relative", "description": "Stacked lines", "type": "string", "enum": [ "unspecified", "absolute", "relative" ] }, "ApisDashboardsV1AstWidgetsLineChart": { "description": "Line chart widget", "type": "object", "properties": { "legend": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLegend" }, "tooltip": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartTooltip" }, "query_definitions": { "description": "Query definitions", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartQueryDefinition" }, "minItems": 1, "maxItems": 4096 }, "stacked_line": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChartStackedLine" } }, "required": [ "legend", "tooltip" ] }, "ApisDashboardsV1AstWidgetDefinitionValueLineChart": { "type": "object", "properties": { "line_chart": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsLineChart" } } }, "ApisDashboardsV1AstWidgetsDataTableLogsQueryAggregation": { "description": "Aggregations", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Aggregation identifier, must be unique within grouping configuration", "type": "string", "format": "uuid", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 36, "maxLength": 36 }, "name": { "example": "count", "description": "Aggregation name, used as column name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "is_visible": { "example": true, "description": "Whether the aggregation is visible", "type": "boolean" }, "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" } }, "required": [ "id", "name", "is_visible", "aggregation" ] }, "ApisDashboardsV1AstWidgetsDataTableLogsQueryGrouping": { "description": "Grouping and aggregation", "type": "object", "properties": { "aggregations": { "description": "Aggregations", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableLogsQueryAggregation" }, "minItems": 0, "maxItems": 4096 }, "group_bys": { "description": "Fields to group by", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstWidgetsDataTableLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "filters": { "description": "Additional filtering done in addition to the Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 }, "grouping": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableLogsQueryGrouping" } } }, "ApisDashboardsV1AstWidgetsDataTableQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableLogsQuery" } } }, "ApisDashboardsV1AstWidgetsDataTableMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "filters": { "description": "Extra filtering on top of the PromQL query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "promql_query" ] }, "ApisDashboardsV1AstWidgetsDataTableQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableMetricsQuery" } } }, "ApisDashboardsV1AstWidgetsDataTableDataprimeQuery": { "description": "Query based on Dataprime language", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Extra filtering on top of the Dataprime query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "dataprime_query" ] }, "ApisDashboardsV1AstWidgetsDataTableQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsDataTableQuery": { "description": "Data source-specific query. This query defines where and how the data is fetched.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsRowStyle": { "example": "list", "description": "Display style for table rows", "type": "string", "enum": [ "unspecified", "one_line", "two_line", "condensed", "json", "list" ] }, "ApisDashboardsV1AstWidgetsDataTableColumn": { "description": "Columns to display including the column order and width", "type": "object", "properties": { "field": { "example": "coralogix.metadata.applicationName", "description": "References a field in result set. In case of aggregation, it references the aggregation identifier", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "width": { "example": 100, "description": "Column width", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } }, "required": [ "field" ] }, "ApisDashboardsV1CommonOrderDirection": { "example": "desc", "description": "Indicates if the order is ascending or descending", "type": "string", "enum": [ "unspecified", "asc", "desc" ] }, "ApisDashboardsV1CommonOrderingField": { "description": "Column used for ordering the results", "type": "object", "properties": { "field": { "description": "The field used for ordering", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "order_direction": { "$ref": "#/components/schemas/ApisDashboardsV1CommonOrderDirection" } } }, "ApisDashboardsV1AstWidgetsDataTable": { "description": "Data table widget", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableQuery" }, "results_per_page": { "example": 10, "description": "Number of results per page", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "row_style": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsRowStyle" }, "columns": { "description": "Columns to display including the column order and width", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTableColumn" }, "minItems": 1, "maxItems": 4096 }, "order_by": { "$ref": "#/components/schemas/ApisDashboardsV1CommonOrderingField" }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" } }, "required": [ "query", "results_per_page", "row_style" ] }, "ApisDashboardsV1AstWidgetDefinitionValueDataTable": { "type": "object", "properties": { "data_table": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsDataTable" } } }, "ApisDashboardsV1AstWidgetsGaugeAggregation": { "example": "sum", "description": "Specifies the aggregation processing.", "type": "string", "enum": [ "unspecified", "last", "min", "max", "avg", "sum" ] }, "ApisDashboardsV1AstWidgetsGaugeMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeAggregation" }, "filters": { "description": "Extra filters applied in addition to the PromQL query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "promql_query", "aggregation" ] }, "ApisDashboardsV1AstWidgetsGaugeQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeMetricsQuery" } } }, "ApisDashboardsV1AstWidgetsGaugeLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "logs_aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" }, "filters": { "description": "Extra filters applied in addition to the Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstWidgetsGaugeQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeLogsQuery" } } }, "ApisDashboardsV1AstWidgetsGaugeDataprimeQuery": { "description": "Query based on Dataprime language", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Extra filters applied in addition to the Dataprime query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "dataprime_query" ] }, "ApisDashboardsV1AstWidgetsGaugeQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsGaugeQuery": { "description": "Data source-specific query. This query defines where and how the data is fetched.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsGaugeUnit": { "example": "usd", "description": "Query result value interpretation", "type": "string", "enum": [ "unspecified", "number", "percent", "microseconds", "milliseconds", "seconds", "bytes", "kbytes", "mbytes", "gbytes", "bytes_iec", "kibytes", "mibytes", "gibytes", "eur_cents", "eur", "usd_cents", "usd" ] }, "ApisDashboardsV1AstWidgetsGaugeThreshold": { "description": "Specifies the thresholds for the gauge. These thresholds determine when the gauge changes color in the Cloud Logs UI.", "type": "object", "properties": { "from": { "example": 0.5, "description": "Value when the color will change", "type": "number", "format": "double" }, "color": { "example": "warning", "description": "Color", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "from", "color" ] }, "ApisDashboardsV1AstWidgetsGaugeThresholdBy": { "example": "background", "description": "What threshold color will be applied to: value or background", "type": "string", "enum": [ "unspecified", "value", "background" ] }, "ApisDashboardsV1AstWidgetsGauge": { "description": "Gauge widget", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeQuery" }, "min": { "example": 0, "description": "Minimum value of the gauge", "type": "number", "format": "double" }, "max": { "example": 100, "description": "Maximum value of the gauge", "type": "number", "format": "double" }, "show_inner_arc": { "example": true, "description": "Show styling for inner arc", "type": "boolean" }, "show_outer_arc": { "example": true, "description": "Show styling for outer arc", "type": "boolean" }, "unit": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeUnit" }, "thresholds": { "description": "Specifies the thresholds for the gauge. These thresholds determine when the gauge changes color in the Cloud Logs UI.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeThreshold" }, "minItems": 1, "maxItems": 4096 }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" }, "threshold_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGaugeThresholdBy" } }, "required": [ "query", "min", "max", "show_inner_arc", "show_outer_arc", "unit", "threshold_by" ] }, "ApisDashboardsV1AstWidgetDefinitionValueGauge": { "type": "object", "properties": { "gauge": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsGauge" } } }, "ApisDashboardsV1AstWidgetsPieChartLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" }, "filters": { "description": "Extra filters on top of Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names_fields": { "description": "Fields to group by", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 1, "maxItems": 2 }, "stacked_group_name_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "aggregation" ] }, "ApisDashboardsV1AstWidgetsPieChartQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartLogsQuery" } } }, "ApisDashboardsV1AstWidgetsPieChartMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "filters": { "description": "Extra filters on top of PromQL query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "example": [ "service", "pod" ], "description": "Fields to group by", "type": "array", "items": { "description": "Fields to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 2 }, "stacked_group_name": { "example": "pod", "description": "Field to be used for stacking", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "promql_query" ] }, "ApisDashboardsV1AstWidgetsPieChartQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartMetricsQuery" } } }, "ApisDashboardsV1AstWidgetsPieChartDataprimeQuery": { "description": "Query based on Dataprime language", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Extra filters on top of Dataprime query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "example": [ "service", "pod" ], "description": "Fields to group by", "type": "array", "items": { "description": "Fields to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 2 }, "stacked_group_name": { "example": "pod", "description": "Field to be used for stacking", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "dataprime_query" ] }, "ApisDashboardsV1AstWidgetsPieChartQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsPieChartQuery": { "description": "Data source specific query. This query defines from where and how to fetch the data", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsPieChartStackDefinition": { "description": "Stack definition", "type": "object", "properties": { "max_slices_per_stack": { "example": 5, "description": "Maximum number of slices per stack", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "stack_name_template": { "example": "{{severity}}", "description": "Template for stack labels", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsPieChartLabelSource": { "example": "stack", "description": "Source of the label", "type": "string", "enum": [ "unspecified", "inner", "stack" ] }, "ApisDashboardsV1AstWidgetsPieChartLabelDefinition": { "description": "Label settings", "type": "object", "properties": { "label_source": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartLabelSource" }, "is_visible": { "example": true, "description": "Controls whether to show the label", "type": "boolean" }, "show_name": { "example": true, "description": "Controls whether to show the name", "type": "boolean" }, "show_value": { "example": true, "description": "Controls whether to show the value", "type": "boolean" }, "show_percentage": { "example": true, "description": "Controls whether to show the percentage", "type": "boolean" } } }, "ApisDashboardsV1AstWidgetsPieChart": { "description": "Pie chart widget", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartQuery" }, "max_slices_per_chart": { "example": 5, "description": "Maximum number of slices to display in the chart", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "min_slice_percentage": { "example": 1, "description": "Minimum percentage of a slice to be displayed", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "stack_definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartStackDefinition" }, "label_definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChartLabelDefinition" }, "show_legend": { "example": true, "description": "Controls whether to show the legend", "type": "boolean" }, "group_name_template": { "description": "Template for group labels", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "unit": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonUnit" }, "color_scheme": { "example": "classic", "description": "Color scheme name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" } }, "required": [ "query", "max_slices_per_chart", "min_slice_percentage", "stack_definition", "label_definition", "show_legend", "color_scheme" ] }, "ApisDashboardsV1AstWidgetDefinitionValuePieChart": { "type": "object", "properties": { "pie_chart": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsPieChart" } } }, "ApisDashboardsV1AstWidgetsBarChartLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" }, "filters": { "description": "Extra filter on top of Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names_fields": { "description": "Group by the specified field", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 1, "maxItems": 2 }, "stacked_group_name_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "aggregation" ] }, "ApisDashboardsV1AstWidgetsBarChartQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartLogsQuery" } } }, "ApisDashboardsV1AstWidgetsBarChartMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "filters": { "description": "Filter to be applied after PromQL query processing", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "example": [ "service", "pod" ], "description": "Labels to group by", "type": "array", "items": { "description": "Labels to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 2 }, "stacked_group_name": { "example": "pod", "description": "Label to stack by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsBarChartQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartMetricsQuery" } } }, "ApisDashboardsV1AstWidgetsBarChartDataprimeQuery": { "description": "Query based on Dataprime language", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Filter to be applied after processing the Dataprime query.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "example": [ "service", "severity" ], "description": "Fields to group by", "type": "array", "items": { "description": "Fields to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 2 }, "stacked_group_name": { "example": "severity", "description": "Field to be used for stacking", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "dataprime_query" ] }, "ApisDashboardsV1AstWidgetsBarChartQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsBarChartQuery": { "description": "Data source specific query. This query defines from where and how to fetch the data", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsBarChartStackDefinition": { "description": "Stack definition", "type": "object", "properties": { "max_slices_per_bar": { "example": 5, "description": "Maximum number of slices per bar", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "stack_name_template": { "example": "{{severity}}", "description": "Template for stack slice label", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsCommonColorsByColorsByStackEmpty": { "description": "Each stack will have the same color across all groups", "type": "object" }, "ApisDashboardsV1AstWidgetsCommonColorsByValueStack": { "type": "object", "properties": { "stack": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByColorsByStackEmpty" } } }, "ApisDashboardsV1AstWidgetsCommonColorsByColorsByGroupByEmpty": { "description": "Each group will have different color and stack color will be derived from group color", "type": "object" }, "ApisDashboardsV1AstWidgetsCommonColorsByValueGroupBy": { "type": "object", "properties": { "group_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByColorsByGroupByEmpty" } } }, "ApisDashboardsV1AstWidgetsCommonColorsByColorsByAggregationEmpty": { "description": "Each aggregation will have different color and stack color will be derived from aggregation color", "type": "object" }, "ApisDashboardsV1AstWidgetsCommonColorsByValueAggregation": { "type": "object", "properties": { "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByColorsByAggregationEmpty" } } }, "ApisDashboardsV1AstWidgetsCommonColorsBy": { "description": "Coloring mode", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByValueStack" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByValueGroupBy" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsByValueAggregation" } ] }, "ApisDashboardsV1AstWidgetsBarChartXAxisXAxisByValueEmpty": { "description": "Categorical axis", "type": "object" }, "ApisDashboardsV1AstWidgetsBarChartXAxisTypeValue": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartXAxisXAxisByValueEmpty" } } }, "ApisDashboardsV1AstWidgetsBarChartXAxisXAxisByTime": { "description": "Time based axis", "type": "object", "properties": { "interval": { "example": "60s", "description": "Time interval", "type": "string", "pattern": "^[0-9]+[smhdw]?$", "minLength": 2, "maxLength": 10 }, "buckets_presented": { "example": 10, "description": "Buckets presented", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 } } }, "ApisDashboardsV1AstWidgetsBarChartXAxisTypeTime": { "type": "object", "properties": { "time": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartXAxisXAxisByTime" } } }, "ApisDashboardsV1AstWidgetsBarChartXAxis": { "description": "X axis mode", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartXAxisTypeValue" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartXAxisTypeTime" } ] }, "ApisDashboardsV1AstWidgetsCommonSortByType": { "example": "name", "description": "Sorting mode", "type": "string", "enum": [ "unspecified", "value", "name" ] }, "ApisDashboardsV1AstWidgetsBarChart": { "description": "Bar chart widget", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartQuery" }, "max_bars_per_chart": { "example": 10, "description": "Maximum number of bars to present in the chart", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "group_name_template": { "example": "{{severity}}", "description": "Template for bar labels", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "stack_definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartStackDefinition" }, "scale_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonScaleType" }, "colors_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsBy" }, "x_axis": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChartXAxis" }, "unit": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonUnit" }, "sort_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonSortByType" }, "color_scheme": { "example": "classic", "description": "Supported values are classic, severity, cold, negative, green, red, blue.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" } }, "required": [ "query", "max_bars_per_chart", "group_name_template", "stack_definition", "scale_type", "colors_by", "x_axis", "unit", "sort_by", "color_scheme" ] }, "ApisDashboardsV1AstWidgetDefinitionValueBarChart": { "type": "object", "properties": { "bar_chart": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsBarChart" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartLogsQuery": { "description": "Logs specific query", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonLuceneQuery" }, "aggregation": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLogsAggregation" }, "filters": { "description": "Extra filter on top of the Lucene query", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterLogsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names_fields": { "description": "Fields to group by", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 1, "maxItems": 2 }, "stacked_group_name_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartLogsQuery" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartMetricsQuery": { "description": "Metrics specific query", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonPromQlQuery" }, "filters": { "description": "Filter to be applied after PromQL query processing", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterMetricsFilter" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "example": [ "service" ], "description": "Labels to group by", "type": "array", "items": { "description": "Labels to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 2 }, "stacked_group_name": { "example": "service", "description": "Label to stack by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartMetricsQuery" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartDataprimeQuery": { "description": "Dataprime specific query", "type": "object", "properties": { "dataprime_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonDataprimeQuery" }, "filters": { "description": "Filter to be applied after processing the Dataprime query.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "minItems": 0, "maxItems": 4096 }, "group_names": { "description": "Fields to group by", "type": "array", "items": { "description": "Fields to group by", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "stacked_group_name": { "description": "Field to be used for stacking", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueDataprime": { "type": "object", "properties": { "dataprime": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartDataprimeQuery" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartQuery": { "description": "Data source-specific query. This query defines where and how the data is fetched.", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueLogs" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartQueryValueDataprime" } ] }, "ApisDashboardsV1AstWidgetsHorizontalBarChartStackDefinition": { "description": "Stack definition", "type": "object", "properties": { "max_slices_per_bar": { "example": 5, "description": "Maximum number of slices per bar", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "stack_name_template": { "example": "{{severity}}", "description": "Template for stack slice label", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewByCategoryEmpty": { "description": "View by category", "type": "object" }, "ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewCategory": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewByCategoryEmpty" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewByValueEmpty": { "description": "View by value", "type": "object" }, "ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewValue": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewByValueEmpty" } } }, "ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewBy": { "description": "Y-axis view mode", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewCategory" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewByYAxisViewValue" } ] }, "ApisDashboardsV1AstWidgetsHorizontalBarChart": { "description": "Horizontal bar chart widget", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartQuery" }, "max_bars_per_chart": { "example": 5, "description": "Maximum number of bars to display in the chart", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "group_name_template": { "example": "{{severity}}", "description": "Template for bar labels", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "stack_definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartStackDefinition" }, "scale_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonScaleType" }, "colors_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonColorsBy" }, "unit": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonUnit" }, "display_on_bar": { "example": true, "description": "Whether to display values on the bars", "type": "boolean" }, "y_axis_view_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChartYAxisViewBy" }, "sort_by": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonSortByType" }, "color_scheme": { "example": "classic", "description": "Color scheme name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "data_mode_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsCommonDataModeType" } }, "required": [ "color_scheme" ] }, "ApisDashboardsV1AstWidgetDefinitionValueHorizontalBarChart": { "type": "object", "properties": { "horizontal_bar_chart": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsHorizontalBarChart" } } }, "ApisDashboardsV1AstWidgetsMarkdown": { "description": "Markdown widget", "type": "object", "properties": { "markdown_text": { "example": "# Database metrics", "description": "Markdown text to render", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 10000 }, "tooltip_text": { "example": " # Database metrics", "description": "Tooltip text on hover", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 1000 } }, "required": [ "markdown_text" ] }, "ApisDashboardsV1AstWidgetDefinitionValueMarkdown": { "type": "object", "properties": { "markdown": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetsMarkdown" } } }, "ApisDashboardsV1AstWidgetDefinition": { "description": "Widget definition containing the widget type and its configuration", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueLineChart" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueDataTable" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueGauge" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValuePieChart" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueBarChart" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueHorizontalBarChart" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinitionValueMarkdown" } ] }, "ApisDashboardsV1AstWidget": { "description": "The widgets in the row", "type": "object", "properties": { "href": { "description": "The widget identifier within the dashboard. The identifier must be unique within the dahsboard.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "id": { "$ref": "#/components/schemas/ApisDashboardsV1Uuid" }, "title": { "example": "Response time", "description": "Widget title", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "description": { "example": "The average response time of the system", "description": "Widget description", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 200 }, "definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidgetDefinition" }, "created_at": { "example": "2021-01-01T00:00:00.000Z", "description": "Creation timestamp", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "updated_at": { "example": "2021-01-01T00:00:00.000Z", "description": "Last update timestamp", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } }, "required": [ "id", "title", "definition" ] }, "ApisDashboardsV1AstRow": { "description": "The rows of the section", "type": "object", "properties": { "href": { "description": "The unique identifier of the row within the layout", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "id": { "$ref": "#/components/schemas/ApisDashboardsV1Uuid" }, "appearance": { "$ref": "#/components/schemas/ApisDashboardsV1AstRowAppearance" }, "widgets": { "description": "The widgets in the row", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstWidget" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "id", "appearance" ] }, "ApisDashboardsV1AstInternalSectionOptionsEmpty": { "type": "object" }, "ApisDashboardsV1AstSectionOptionsValueInternal": { "type": "object", "properties": { "internal": { "$ref": "#/components/schemas/ApisDashboardsV1AstInternalSectionOptionsEmpty" } } }, "ApisDashboardsV1AstSectionPredefinedColor": { "example": "orange", "type": "string", "enum": [ "cyan", "green", "blue", "purple", "magenta", "pink", "orange" ] }, "ApisDashboardsV1AstSectionColor": { "type": "object", "properties": { "predefined": { "$ref": "#/components/schemas/ApisDashboardsV1AstSectionPredefinedColor" } } }, "ApisDashboardsV1AstCustomSectionOptions": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "collapsed": { "example": true, "type": "boolean" }, "color": { "$ref": "#/components/schemas/ApisDashboardsV1AstSectionColor" } } }, "ApisDashboardsV1AstSectionOptionsValueCustom": { "type": "object", "properties": { "custom": { "$ref": "#/components/schemas/ApisDashboardsV1AstCustomSectionOptions" } } }, "ApisDashboardsV1AstSectionOptions": { "description": "The options for configuring this section", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstSectionOptionsValueInternal" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstSectionOptionsValueCustom" } ] }, "ApisDashboardsV1AstSection": { "description": "The sections of the layout", "type": "object", "properties": { "href": { "description": "The unique identifier of the section within the layout", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "id": { "$ref": "#/components/schemas/ApisDashboardsV1Uuid" }, "rows": { "description": "The rows of the section", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstRow" }, "minItems": 0, "maxItems": 4096 }, "options": { "$ref": "#/components/schemas/ApisDashboardsV1AstSectionOptions" } }, "required": [ "id" ] }, "ApisDashboardsV1AstLayout": { "description": "Layout configuration for the dashboard's visual elements.", "type": "object", "properties": { "sections": { "description": "The sections of the layout", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstSection" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstMultiSelectLogsPathSource": { "description": "Unique values for a given logs path", "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "observation_field" ] }, "ApisDashboardsV1AstMultiSelectSourceValueLogsPath": { "type": "object", "properties": { "logs_path": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectLogsPathSource" } } }, "ApisDashboardsV1AstMultiSelectMetricLabelSource": { "description": "Unique values for a given metric label", "type": "object", "properties": { "metric_name": { "example": "http_requests_total", "description": "Metric name used to source unique values", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "label": { "example": "service", "description": "Metric name used to source unique values", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "metric_name", "label" ] }, "ApisDashboardsV1AstMultiSelectSourceValueMetricLabel": { "type": "object", "properties": { "metric_label": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectMetricLabelSource" } } }, "ApisDashboardsV1AstMultiSelectConstantListSource": { "description": "List of constant source values", "type": "object", "properties": { "values": { "example": [ "production", "staging" ], "description": "List of constant source values", "type": "array", "items": { "description": "List of constant source values", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 4096 } }, "required": [ "values" ] }, "ApisDashboardsV1AstMultiSelectSourceValueConstantList": { "type": "object", "properties": { "constant_list": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectConstantListSource" } } }, "ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeFieldName": { "type": "object", "properties": { "log_regex": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeValueFieldName": { "type": "object", "properties": { "field_name": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeFieldName" } } }, "ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeFieldValue": { "type": "object", "properties": { "observation_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } } }, "ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeValueFieldValue": { "type": "object", "properties": { "field_value": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeFieldValue" } } }, "ApisDashboardsV1AstMultiSelectQueryLogsQueryType": { "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeValueFieldName" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQueryTypeValueFieldValue" } ] }, "ApisDashboardsV1AstMultiSelectQueryLogsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQueryType" } } }, "ApisDashboardsV1AstMultiSelectQueryValueLogsQuery": { "type": "object", "properties": { "logs_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryLogsQuery" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeMetricName": { "type": "object", "properties": { "metric_regex": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueMetricName": { "type": "object", "properties": { "metric_name": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeMetricName" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeLabelName": { "type": "object", "properties": { "metric_regex": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueLabelName": { "type": "object", "properties": { "label_name": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeLabelName" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariableValueStringValue": { "type": "object", "properties": { "string_value": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariableValueVariableName": { "type": "object", "properties": { "variable_name": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable": { "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariableValueStringValue" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariableValueVariableName" } ] }, "ApisDashboardsV1AstMultiSelectQueryMetricsQuerySelectionListSelection": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQuerySelection": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQuerySelectionListSelection" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryEquals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQuerySelection" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperatorValueEquals": { "type": "object", "properties": { "equals": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryEquals" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryNotEquals": { "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQuerySelection" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperatorValueNotEquals": { "type": "object", "properties": { "not_equals": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryNotEquals" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperator": { "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperatorValueEquals" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperatorValueNotEquals" } ] }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryMetricsLabelFilter": { "type": "object", "properties": { "metric": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable" }, "label": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable" }, "operator": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryOperator" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeLabelValue": { "type": "object", "properties": { "metric_name": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable" }, "label_name": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryStringOrVariable" }, "label_filters": { "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryMetricsLabelFilter" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueLabelValue": { "type": "object", "properties": { "label_value": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeLabelValue" } } }, "ApisDashboardsV1AstMultiSelectQueryMetricsQueryType": { "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueMetricName" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueLabelName" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryTypeValueLabelValue" } ] }, "ApisDashboardsV1AstMultiSelectQueryMetricsQuery": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQueryType" } } }, "ApisDashboardsV1AstMultiSelectQueryValueMetricsQuery": { "type": "object", "properties": { "metrics_query": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryMetricsQuery" } } }, "ApisDashboardsV1AstMultiSelectQuery": { "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryValueLogsQuery" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQueryValueMetricsQuery" } ] }, "ApisDashboardsV1AstMultiSelectRefreshStrategy": { "example": "on_time_frame_change", "type": "string", "enum": [ "on_dashboard_load", "on_time_frame_change" ] }, "ApisDashboardsV1AstMultiSelectValueDisplayOptions": { "type": "object", "properties": { "value_regex": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "label_regex": { "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstMultiSelectQuerySource": { "description": "The query of the source", "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQuery" }, "refresh_strategy": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectRefreshStrategy" }, "value_display_options": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectValueDisplayOptions" } } }, "ApisDashboardsV1AstMultiSelectSourceValueQuery": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectQuerySource" } } }, "ApisDashboardsV1AstMultiSelectSource": { "description": "Variable value source", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSourceValueLogsPath" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSourceValueMetricLabel" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSourceValueConstantList" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSourceValueQuery" } ] }, "ApisDashboardsV1AstMultiSelectSelectionAllSelectionEmpty": { "description": "All values are selected, usually translated to wildcard (*)", "type": "object" }, "ApisDashboardsV1AstMultiSelectSelectionValueAll": { "type": "object", "properties": { "all": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSelectionAllSelectionEmpty" } } }, "ApisDashboardsV1AstMultiSelectSelectionListSelection": { "description": "Specific values are selected", "type": "object", "properties": { "values": { "example": [ "production", "staging" ], "description": "Selected values", "type": "array", "items": { "description": "Selected values", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "labels": { "description": "Selected labels", "type": "array", "items": { "description": "Selected labels", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstMultiSelectSelectionValueList": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSelectionListSelection" } } }, "ApisDashboardsV1AstMultiSelectSelection": { "description": "State of what is currently selected", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSelectionValueAll" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSelectionValueList" } ] }, "ApisDashboardsV1AstMultiSelectVariableSelectionOptionsSelectionType": { "example": "single", "type": "string", "enum": [ "multi_all", "multi", "single" ] }, "ApisDashboardsV1AstMultiSelectVariableSelectionOptions": { "description": "The multi-select options to configure variable", "type": "object", "properties": { "selection_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectVariableSelectionOptionsSelectionType" } } }, "ApisDashboardsV1AstMultiSelect": { "description": "Multi-select value", "type": "object", "properties": { "source": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSource" }, "selection": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectSelection" }, "values_order_direction": { "$ref": "#/components/schemas/ApisDashboardsV1CommonOrderDirection" }, "selection_options": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelectVariableSelectionOptions" } }, "required": [ "source", "selection", "values_order_direction" ] }, "ApisDashboardsV1AstVariableDefinitionValueMultiSelect": { "type": "object", "properties": { "multi_select": { "$ref": "#/components/schemas/ApisDashboardsV1AstMultiSelect" } } }, "ApisDashboardsV1AstVariableDefinition": { "description": "Definition of the dashboard variable", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstVariableDefinitionValueMultiSelect" } ] }, "ApisDashboardsV1AstVariableDisplayType": { "example": "nothing", "description": "The display type of variable", "type": "string", "enum": [ "label_value", "value", "nothing" ] }, "ApisDashboardsV1AstVariable": { "description": "List of variables that can be used within the dashboard for dynamic content.", "type": "object", "properties": { "name": { "example": "service_name", "description": "Name of the variable which can be used in templates", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "definition": { "$ref": "#/components/schemas/ApisDashboardsV1AstVariableDefinition" }, "display_name": { "example": "Service Name", "description": "The name of variable.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "description": { "description": "The description of variable", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "display_type": { "$ref": "#/components/schemas/ApisDashboardsV1AstVariableDisplayType" } }, "required": [ "name", "definition", "display_name" ] }, "ApisDashboardsV1AstFilter": { "description": "List of filters that can be applied to the dashboard's data.", "type": "object", "properties": { "source": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilterSource" }, "enabled": { "example": true, "description": "Indicates if the filter is currently enabled or not.", "type": "boolean" }, "collapsed": { "example": true, "description": "Indicates if the filter's UI representation will be collapsed or expanded.", "type": "boolean" } } }, "ApisDashboardsV1CommonPromQlQuery": { "description": "PromQL query", "type": "object", "properties": { "value": { "example": "sum(up)", "description": "The PromQL query string.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstAnnotationMetricsSourceStartTimeMetricEmpty": { "description": "Take first data point and use its value as annotation timestamp (instead of the point's own timestamp)", "type": "object" }, "ApisDashboardsV1AstAnnotationMetricsSourceStrategy": { "description": "Strategy for turning metrics data into annotations", "type": "object", "properties": { "start_time_metric": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationMetricsSourceStartTimeMetricEmpty" } } }, "ApisDashboardsV1AstAnnotationMetricsSource": { "description": "Metrics source", "type": "object", "properties": { "promql_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonPromQlQuery" }, "strategy": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationMetricsSourceStrategy" }, "message_template": { "description": "Message template for the annotation message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "labels": { "description": "Labels to display in the annotation", "type": "array", "items": { "description": "Labels to display in the annotation", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 10 }, "minItems": 0, "maxItems": 4096 } } }, "ApisDashboardsV1AstAnnotationSourceValueMetrics": { "type": "object", "properties": { "metrics": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationMetricsSource" } } }, "ApisDashboardsV1CommonLuceneQuery": { "description": "Lucene query", "type": "object", "properties": { "value": { "example": "coralogix.metadata.applicationName:\"production\"", "description": "The Lucene query string.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyInstant": { "description": "Event timestamp is extracted from the log entry", "type": "object", "properties": { "timestamp_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "timestamp_field" ] }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyValueInstant": { "type": "object", "properties": { "instant": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyInstant" } } }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyRange": { "description": "Event start and end timestamps are extracted from the log entry", "type": "object", "properties": { "start_timestamp_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "end_timestamp_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "start_timestamp_field", "end_timestamp_field" ] }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyValueRange": { "type": "object", "properties": { "range": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyRange" } } }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyDuration": { "description": "Event start timestamp and duration are extracted from the log entry", "type": "object", "properties": { "start_timestamp_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "duration_field": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" } }, "required": [ "start_timestamp_field", "duration_field" ] }, "ApisDashboardsV1AstAnnotationLogsSourceStrategyValueDuration": { "type": "object", "properties": { "duration": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyDuration" } } }, "ApisDashboardsV1AstAnnotationLogsSourceStrategy": { "description": "Strategy for turning logs data into annotations", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyValueInstant" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyValueRange" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategyValueDuration" } ] }, "ApisDashboardsV1AstAnnotationLogsSource": { "description": "Logs source", "type": "object", "properties": { "lucene_query": { "$ref": "#/components/schemas/ApisDashboardsV1CommonLuceneQuery" }, "strategy": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSourceStrategy" }, "message_template": { "description": "Template for the annotation message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "label_fields": { "description": "Labels to display in the annotation", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1CommonObservationField" }, "minItems": 0, "maxItems": 10 } }, "required": [ "lucene_query", "strategy" ] }, "ApisDashboardsV1AstAnnotationSourceValueLogs": { "type": "object", "properties": { "logs": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationLogsSource" } } }, "ApisDashboardsV1AstAnnotationSource": { "description": "Source of the annotation events", "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationSourceValueMetrics" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationSourceValueLogs" } ] }, "ApisDashboardsV1AstAnnotation": { "description": "List of annotations that can be applied to the dashboard's visual elements.", "type": "object", "properties": { "href": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Unique identifier within the dashboard", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Unique identifier within the dashboard", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Deployments", "description": "Name of the annotation", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "enabled": { "example": true, "description": "Whether the annotation is enabled. If enabled, annotations are applied.", "type": "boolean" }, "source": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotationSource" } }, "required": [ "id", "name", "enabled", "source" ] }, "Dashboard": { "example": { "filters": [ { "collapsed": false, "enabled": true, "source": { "logs": { "observation_field": { "keypath": [ "applicationname" ], "scope": "label" }, "operator": { "equals": { "selection": { "list": { "values": [ "app1", "app2" ] } } } } } } }, { "collapsed": false, "enabled": true, "source": { "logs": { "observation_field": { "keypath": [ "subsystemname" ], "scope": "label" }, "operator": { "equals": { "selection": { "list": { "values": [ "subsystem1", "subsystem2" ] } } } } } } } ], "id": "YE53uJm1vmjojyNuvTv4S", "layout": { "sections": [ { "id": { "value": "10c27980-3532-21b0-8069-0c9110f03c90" }, "rows": [ { "appearance": { "height": 19 }, "id": { "value": "036ecea7-2116-c2e4-2e59-4e9b78adb020" }, "widgets": [ { "definition": { "line_chart": { "legend": { "group_by_query": true, "is_visible": true }, "query_definitions": [ { "color_scheme": "classic", "data_mode_type": "high_unspecified", "id": "e4560525-521c-49e7-a7de-a2925626c304", "is_visible": true, "name": "Query1", "query": { "metrics": { "promql_query": { "value": "sum(rate(cx_data_usage_bytes_total[20m]))by(pillar,tier)" } } }, "resolution": { "buckets_presented": 96 }, "scale_type": "linear", "series_count_limit": "20", "unit": "unspecified" } ], "tooltip": { "show_labels": false, "type": "all" } } }, "id": { "value": "85cdf1ac-2c3a-bb2f-9a85-a4e0bea04d49" }, "title": "Size" } ] }, { "appearance": { "height": 19 }, "id": { "value": "2ec9df23-1980-c62a-696e-9ce1ea55c097" }, "widgets": [ { "definition": { "line_chart": { "legend": { "group_by_query": true, "is_visible": true }, "query_definitions": [ { "color_scheme": "classic", "data_mode_type": "high_unspecified", "id": "be33038a-414f-4b4a-bf70-c5b25d39ac3d", "is_visible": true, "name": "Query1", "query": { "metrics": { "promql_query": { "value": "sum(rate(cx_data_usage_units[20m]))by(pillar,tier)" } } }, "resolution": { "buckets_presented": 96 }, "scale_type": "linear", "series_count_limit": "20", "unit": "unspecified" } ], "tooltip": { "show_labels": false, "type": "all" } } }, "id": { "value": "36d0cb4c-bcec-4e06-794c-e644c676966a" }, "title": "Unit" } ] }, { "appearance": { "height": 19 }, "id": { "value": "4d5c835b-d33b-c76c-59f9-5da2f889d4dd" }, "widgets": [ { "definition": { "line_chart": { "legend": { "group_by_query": true, "is_visible": true }, "query_definitions": [ { "color_scheme": "classic", "data_mode_type": "high_unspecified", "id": "a3c9a564-8911-4cb1-a1a3-03b773bc063b", "is_visible": true, "name": "Dailyusage", "query": { "metrics": { "promql_query": { "value": "sum(cx_data_usage_units)" } } }, "resolution": { "buckets_presented": 96 }, "scale_type": "linear", "series_count_limit": "20", "unit": "unspecified" }, { "color_scheme": "classic", "data_mode_type": "high_unspecified", "id": "42a92fbc-fd48-533d-9332-5e2a5b20dc41", "is_visible": true, "name": "Totalplan", "query": { "metrics": { "promql_query": { "value": "sum(cx_data_plan_units_per_day)" } } }, "resolution": { "buckets_presented": 96 }, "scale_type": "linear", "series_count_limit": "20", "unit": "unspecified" } ], "tooltip": { "show_labels": false, "type": "all" } } }, "id": { "value": "5c845dee-e297-7e7d-8a65-d59f8b967d8c" }, "title": "Newlinechart" } ] }, { "appearance": { "height": 19 }, "id": { "value": "c1c425fa-9c21-473a-6711-2b2866ab332e" }, "widgets": [ { "definition": { "pie_chart": { "color_scheme": "classic", "data_mode_type": "high_unspecified", "label_definition": { "is_visible": true, "label_source": "inner", "show_name": true, "show_percentage": true, "show_value": true }, "max_slices_per_chart": 8, "min_slice_percentage": 1, "query": { "metrics": { "group_names": [ "blocking_reason_type" ], "promql_query": { "value": "sum(increase(cx_data_usage_bytes_total{blocking_reason_type!=\\\"cx_null\\\"}[7d]))by(blocking_reason_type,blocking_reason_name)" }, "stacked_group_name": "blocking_reason_name" } }, "show_legend": true, "stack_definition": { "max_slices_per_stack": 6 }, "unit": "bytes" } }, "id": { "value": "3126debb-4d34-11fb-45d1-020f614b3f0c" }, "title": "Blockedreason" } ] }, { "appearance": { "height": 19 }, "id": { "value": "20558c76-7f80-179a-72a1-2e234caa2e28" }, "widgets": [ { "definition": { "line_chart": { "legend": { "group_by_query": true, "is_visible": true }, "query_definitions": [ { "color_scheme": "cold", "data_mode_type": "high_unspecified", "id": "0ed43c46-ffd1-835a-b316-e63aa4f375ce", "is_visible": true, "name": "Query1", "query": { "metrics": { "promql_query": { "value": "sum(cx_data_usage_units)" } } }, "resolution": { "buckets_presented": 96 }, "scale_type": "linear", "series_count_limit": "20", "unit": "unspecified" } ], "tooltip": { "show_labels": false, "type": "all" } } }, "id": { "value": "b18d1177-b8c4-3e4e-d8df-39d9ecba22d9" }, "title": "unitsovertime" } ] } ] } ] }, "name": "DataUsageToMetrics Dashboard", "relative_time_frame": "86400s" }, "description": "Dashboard represents the structure and configuration of a custom dashboard.", "properties": { "href": { "example": "6U1Q8Hpa263Se8PkRKaiE", "description": "Unique identifier for the dashboard.", "type": "string", "pattern": "^[a-zA-Z0-9]{21}$", "minLength": 21, "maxLength": 21 }, "id": { "example": "6U1Q8Hpa263Se8PkRKaiE", "description": "Unique identifier for the dashboard.", "type": "string", "pattern": "^[a-zA-Z0-9]{21}$", "minLength": 21, "maxLength": 21 }, "name": { "example": "My Dashboard", "description": "Display name of the dashboard.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 100 }, "description": { "example": "This dashboard shows the performance of our production environment.", "description": "Brief description or summary of the dashboard's purpose or content.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 200 }, "layout": { "$ref": "#/components/schemas/ApisDashboardsV1AstLayout" }, "variables": { "description": "List of variables that can be used within the dashboard for dynamic content.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstVariable" }, "minItems": 0, "maxItems": 100 }, "filters": { "description": "List of filters that can be applied to the dashboard's data.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstFilter" }, "minItems": 0, "maxItems": 100 }, "annotations": { "description": "List of annotations that can be applied to the dashboard's visual elements.", "type": "array", "items": { "$ref": "#/components/schemas/ApisDashboardsV1AstAnnotation" }, "minItems": 0, "maxItems": 100 } }, "required": [ "name", "layout" ], "oneOf": [ { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardTimeFrameAbsoluteTimeFrame" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardTimeFrameRelativeTimeFrame" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardFolderFolderId" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardFolderFolderPath" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshOff" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshTwoMinutes" }, { "$ref": "#/components/schemas/ApisDashboardsV1AstDashboardAutoRefreshFiveMinutes" } ] }, "DashboardFolder": { "description": "Dashboard folder", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The UUID of dashboard folder.", "type": "string", "format": "uuid", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 36, "maxLength": 36 }, "name": { "example": "My Folder", "description": "Name of the dashboard folder.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "parent_id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "(Optional) The dashboard folder parent ID, optional.\n If not set, the folder is a root folder.\n If set, the folder is a subfolder of the parent folder and needs to be a uuid", "type": "string", "format": "uuid", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 36, "maxLength": 36 } }, "required": [ "name" ] }, "DashboardSummary": { "description": "List of dashboards", "type": "object", "properties": { "href": { "example": "6U1Q8Hpa263Se8PkRKaiE", "description": "Unique identifier for the dashboard", "type": "string", "pattern": "^[a-zA-Z0-9]{21}$", "minLength": 21, "maxLength": 21 }, "id": { "example": "6U1Q8Hpa263Se8PkRKaiE", "description": "Unique identifier for the dashboard", "type": "string", "pattern": "^[a-zA-Z0-9]{21}$", "minLength": 21, "maxLength": 21 }, "name": { "example": "Production metrics", "description": "Display name of the dashboard", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Response time, error rate and traffic volume", "description": "Brief description or summary of the dashboard's purpose or content", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "is_default": { "example": true, "description": "Indicates whether the dashboard is the default dashboard for the user", "type": "boolean" }, "is_pinned": { "example": true, "description": "Indicates whether the dashboard is pinned", "type": "boolean" }, "create_time": { "example": "2021-01-01T00:00:00.000Z", "description": "Timestamp when the dashboard was created", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "update_time": { "example": "2021-01-01T00:00:00.000Z", "description": "Timestamp when the dashboard was last updated", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "folder": { "$ref": "#/components/schemas/DashboardFolder" } }, "required": [ "id", "name" ] }, "DashboardCollection": { "description": "List of dashboards", "type": "object", "properties": { "dashboards": { "description": "List of dashboards", "type": "array", "items": { "$ref": "#/components/schemas/DashboardSummary" }, "minItems": 0, "maxItems": 4096 } } }, "DataAccessRuleEntityType": { "example": "logs", "description": "Filter's Entity Type", "type": "string", "enum": [ "unspecified", "logs" ] }, "DataAccessRuleFilter": { "description": "List of the filters comprising the data access rule", "type": "object", "properties": { "entity_type": { "$ref": "#/components/schemas/DataAccessRuleEntityType" }, "expression": { "example": "true", "description": "Expression of the filter", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "entity_type", "expression" ] }, "DataAccessRule": { "example": { "default_expression": " foo == 'bar'", "description": "Data access rule intended for testing", "display_name": "Test data access rule", "filters": [ { "entity_type": "logs", "expression": " foo == 'bar'" } ], "id": "c7780bc1-4767-4c84-b23d-403dc1c923ff" }, "description": "Data access rule details", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Data access rule ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "display_name": { "example": "Data access rule for the 'users' group", "description": "Data access rule Display Name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "The data access rule that defines the restriction on the `users' group.", "description": "Optional data access rule description", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "filters": { "description": "List of the filters comprising the data access rule", "type": "array", "items": { "$ref": "#/components/schemas/DataAccessRuleFilter" }, "minItems": 0, "maxItems": 4096 }, "default_expression": { "example": "true", "description": "Default expression to use when no filter matches the query", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "id", "display_name", "default_expression" ] }, "DataAccessRuleCollection": { "example": { "data_access_rules": [ { "default_expression": " foo == 'bar'", "description": "Data access rule intended for testing", "display_name": "Test data access rule", "filters": [ { "entity_type": "logs", "expression": " foo == 'bar'" } ], "id": "c7780bc1-4767-4c84-b23d-403dc1c923ff" } ] }, "description": "Get Data Access Rules Response", "type": "object", "properties": { "data_access_rules": { "description": "Data access rule details", "type": "array", "items": { "$ref": "#/components/schemas/DataAccessRule" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "data_access_rules" ] }, "DataAccessRulePrototype": { "example": { "default_expression": " foo == 'bar'", "description": "Data access rule intended for testing", "display_name": "Test data access rule", "filters": [ { "entity_type": "logs", "expression": " foo == 'bar'" } ] }, "description": "Create data access rule Request", "type": "object", "properties": { "display_name": { "example": "Data access rule for the 'users' group", "description": "Display Name for the data access rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Data access rule that defines a restriction on the 'users' group", "description": "Description for the data access rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "filters": { "description": "Filters for the data access rule", "type": "array", "items": { "$ref": "#/components/schemas/DataAccessRuleFilter" }, "minItems": 0, "maxItems": 4096 }, "default_expression": { "example": "true", "description": "Default Expression for the data access rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "display_name", "filters", "default_expression" ] }, "DatausageV1Range": { "example": "last_week", "description": "The range of days to retrieve data usage", "default": "current_month", "type": "string", "enum": [ "current_month", "last_30_days", "last_90_days", "last_week" ] }, "DatausageV1Query": { "example": "daily", "description": "Query type for the data usage", "default": "daily", "type": "string", "enum": [ "daily", "detailed" ] }, "DataUsage": { "description": "Data usage statistics", "type": "object", "properties": { "timestamp": { "example": "2021-01-01T00:00:00.000Z", "description": "Day of the daily usage report", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "size": { "description": "Blocked data in GB", "type": "number", "format": "float" }, "application": { "description": "Report data usage for this subsystem", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "subsystem": { "description": "Subsystem for which the data usage is reported", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "entity_type": { "description": "Report data usage for this entity type", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "severity": { "$ref": "#/components/schemas/DatausageV1Severity" }, "priority": { "$ref": "#/components/schemas/DatausageV1Priority" } }, "required": [ "timestamp", "size" ] }, "DataUsageCollection": { "type": "object", "properties": { "data_usages": { "description": "List of data usages", "type": "array", "items": { "$ref": "#/components/schemas/DataUsage" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "data_usages" ] }, "DatausageV1Severity": { "example": "critical", "type": "string", "enum": [ "debug", "verbose", "info", "warning", "error", "critical" ] }, "DatausageV1Priority": { "example": "blocked", "type": "string", "enum": [ "low", "medium", "high", "blocked" ] }, "DataUsageMetricsExportStatus": { "description": "The data usage metrics export status", "type": "object", "properties": { "enabled": { "example": true, "description": "Whether metrics export is enabled or not. When 'true' metrics are exported.", "type": "boolean" } }, "required": [ "enabled" ] }, "EnrichmentV1GeoIpTypeEmpty": { "description": "The geo IP enrichment", "type": "object" }, "EnrichmentV1EnrichmentTypeTypeGeoIp": { "type": "object", "properties": { "geo_ip": { "$ref": "#/components/schemas/EnrichmentV1GeoIpTypeEmpty" } } }, "EnrichmentV1SuspiciousIpTypeEmpty": { "description": "The suspicious IP enrichment", "type": "object" }, "EnrichmentV1EnrichmentTypeTypeSuspiciousIp": { "type": "object", "properties": { "suspicious_ip": { "$ref": "#/components/schemas/EnrichmentV1SuspiciousIpTypeEmpty" } } }, "EnrichmentV1CustomEnrichmentType": { "description": "The custom enrichment", "type": "object", "properties": { "id": { "example": 1, "description": "The ID of the custom enrichment", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } } }, "EnrichmentV1EnrichmentTypeTypeCustomEnrichment": { "type": "object", "properties": { "custom_enrichment": { "$ref": "#/components/schemas/EnrichmentV1CustomEnrichmentType" } } }, "EnrichmentV1EnrichmentType": { "description": "The enrichment type", "oneOf": [ { "$ref": "#/components/schemas/EnrichmentV1EnrichmentTypeTypeGeoIp" }, { "$ref": "#/components/schemas/EnrichmentV1EnrichmentTypeTypeSuspiciousIp" }, { "$ref": "#/components/schemas/EnrichmentV1EnrichmentTypeTypeCustomEnrichment" } ] }, "Enrichment": { "description": "The enrichments", "type": "object", "properties": { "id": { "example": 1, "description": "The enrichment ID", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "field_name": { "example": "sourceIPs", "description": "The enrichment field name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "enrichment_type": { "$ref": "#/components/schemas/EnrichmentV1EnrichmentType" } }, "required": [ "id", "field_name", "enrichment_type" ] }, "EnrichmentCollection": { "example": { "enrichments": [ { "enrichment_type": { "geo_ip": {} }, "field_name": "ip", "id": 3 }, { "enrichment_type": { "geo_ip": {} }, "field_name": "client_ip", "id": 6 }, { "enrichment_type": { "suspicious_ip": {} }, "field_name": "client_ip", "id": 23 }, { "enrichment_type": { "custom_enrichment": { "id": 17 } }, "field_name": "phone_code", "id": 24 } ] }, "description": "The enrichments collection", "type": "object", "properties": { "enrichments": { "description": "The enrichments", "type": "array", "items": { "$ref": "#/components/schemas/Enrichment" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "enrichments" ] }, "EnrichmentPrototype": { "example": { "enrichment_type": { "geo_ip": {} }, "field_name": "ip" }, "description": "The model use to create an enrichment", "type": "object", "properties": { "field_name": { "example": "sourceIPs", "description": "The name of the field to enrich", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "enrichment_type": { "$ref": "#/components/schemas/EnrichmentV1EnrichmentType" } }, "required": [ "field_name", "enrichment_type" ] }, "ApisLogs2metricsV2Severity": { "example": "critical", "description": "Severity type filters", "type": "string", "enum": [ "unspecified", "debug", "verbose", "info", "warning", "error", "critical" ] }, "ApisLogs2metricsV2LogsQuery": { "description": "Events to Metrics logs query", "type": "object", "properties": { "lucene": { "example": "log_obj.numeric_field: [50 TO 100]", "description": "Lucene query", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "alias": { "example": "new_query", "description": "Alias", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "applicationname_filters": { "example": [ "app_name" ], "description": "Application name filters", "type": "array", "items": { "description": "Application name filters", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "subsystemname_filters": { "example": [ "sub_name" ], "description": "Subsystem names filters", "type": "array", "items": { "description": "Subsystem names filters", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "severity_filters": { "example": [ "critical" ], "description": "Severity type filters", "type": "array", "items": { "$ref": "#/components/schemas/ApisLogs2metricsV2Severity" }, "minItems": 0, "maxItems": 4096 } } }, "ApisEvents2metricsV2E2mCreateParamsQueryLogsQuery": { "type": "object", "properties": { "logs_query": { "$ref": "#/components/schemas/ApisLogs2metricsV2LogsQuery" } } }, "ApisEvents2metricsV2MetricLabel": { "description": "Events to Metrics metric labels", "type": "object", "properties": { "target_label": { "example": "alias_label_name", "description": "Metric label target alias name", "type": "string", "pattern": "^[\\w/-]+$", "minLength": 1, "maxLength": 4096 }, "source_field": { "example": "log_obj.string_value", "description": "Metric label source field", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } } }, "ApisEvents2metricsV2E2mAggSamplesSampleType": { "example": "max", "description": "Type of the sample.", "type": "string", "enum": [ "unspecified", "min", "max" ] }, "ApisEvents2metricsV2E2mAggSamples": { "description": "Events to Metrics aggregation metadata of samples", "type": "object", "properties": { "sample_type": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mAggSamplesSampleType" } } }, "ApisEvents2metricsV2AggregationAggMetadataSamples": { "type": "object", "properties": { "samples": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mAggSamples" } } }, "ApisEvents2metricsV2E2mAggHistogram": { "description": "Events to Metrics aggregate histogram type metadata", "type": "object", "properties": { "buckets": { "example": [ 2 ], "description": "Histogram buckets of the Events to Metrics", "type": "array", "items": { "description": "Histogram buckets of the Events to Metrics", "type": "number", "format": "float" }, "minItems": 0, "maxItems": 4096 } } }, "ApisEvents2metricsV2AggregationAggMetadataHistogram": { "type": "object", "properties": { "histogram": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mAggHistogram" } } }, "ApisEvents2metricsV2AggregationAggType": { "example": "samples", "description": "Aggregation type", "type": "string", "enum": [ "unspecified", "min", "max", "count", "avg", "sum", "histogram", "samples" ] }, "ApisEvents2metricsV2Aggregation": { "description": "Represents Aggregation type list", "properties": { "enabled": { "example": true, "description": "Determines if aggregation is enabled or not.", "type": "boolean" }, "agg_type": { "$ref": "#/components/schemas/ApisEvents2metricsV2AggregationAggType" }, "target_metric_name": { "example": "alias_field_name_agg_func", "description": "Target metric field alias name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "oneOf": [ { "$ref": "#/components/schemas/ApisEvents2metricsV2AggregationAggMetadataSamples" }, { "$ref": "#/components/schemas/ApisEvents2metricsV2AggregationAggMetadataHistogram" } ] }, "ApisEvents2metricsV2MetricField": { "description": "Events to Metrics metric fields", "type": "object", "properties": { "target_base_metric_name": { "example": "alias_field_name", "description": "Target metric field alias name", "type": "string", "pattern": "^[\\w/-]+$", "minLength": 1, "maxLength": 4096 }, "source_field": { "example": "log_obj.numeric_field", "description": "Source field", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "aggregations": { "description": "The list of available aggregation types", "type": "array", "items": { "$ref": "#/components/schemas/ApisEvents2metricsV2Aggregation" }, "minItems": 0, "maxItems": 4096 } } }, "ApisEvents2metricsV2E2mType": { "example": "logs2metrics", "description": "Events to Metrics type", "type": "string", "enum": [ "unspecified", "logs2metrics" ] }, "Event2MetricPrototype": { "example": { "description": "Test Events to Metrics", "logs_query": { "lucene": "logs" }, "name": "test em2", "permutations_limit": 1, "type": "logs2metrics" }, "description": "Events to Metrics Create message", "properties": { "name": { "example": "Service catalog latency", "description": "Name of Events to Metrics to create", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "avg and max the latency of catalog service", "description": "Description of Events to Metrics to create", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "permutations_limit": { "example": 30000, "description": "The permutation limit of the Events to Metrics", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "metric_labels": { "description": "Events to Metrics metric labels", "type": "array", "items": { "$ref": "#/components/schemas/ApisEvents2metricsV2MetricLabel" }, "minItems": 0, "maxItems": 4096 }, "metric_fields": { "description": "Events to Metrics metric fields", "type": "array", "items": { "$ref": "#/components/schemas/ApisEvents2metricsV2MetricField" }, "minItems": 0, "maxItems": 4096 }, "type": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mType" } }, "required": [ "name" ], "oneOf": [ { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mCreateParamsQueryLogsQuery" } ] }, "ApisEvents2metricsV2E2mQueryLogsQuery": { "type": "object", "properties": { "logs_query": { "$ref": "#/components/schemas/ApisLogs2metricsV2LogsQuery" } } }, "ApisEvents2metricsV2E2mPermutations": { "description": "Represents the limit of the permutations and if the limit was exceeded", "type": "object", "properties": { "limit": { "example": 30000, "description": "Events to Metrics permutation limit", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "has_exceeded_limit": { "example": true, "description": "Flag to indicate if limit was exceeded", "type": "boolean" } } }, "Event2Metric": { "example": { "create_time": "2024-03-11T10:38:21.000Z", "description": "Test Events to Metrics updated", "id": "93bde7ad-651f-48f5-96dd-e7d6b2c2a9de", "is_internal": true, "logs_query": { "lucene": "logs" }, "name": "test em2", "permutations": { "limit": 1 }, "type": "logs2metrics", "update_time": "2024-03-11T10:38:21.000Z" }, "description": "Events to Metrics represents the Event to metrics base model.", "properties": { "id": { "example": "d6a3658e-78d2-47d0-9b81-b2c551f01b09", "description": "Events to Metrics unique ID, required on update requests", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Service_catalog_latency", "description": "Name of the Events to Metrics", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "avg and max the latency of catalog service", "description": "Description of the Events to Metrics", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "create_time": { "example": "2022-06-30T12:30:00Z'", "description": "Events to Metrics create time", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "update_time": { "example": "2022-06-30T12:30:00Z'", "description": "Events to Metrics update time", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "permutations": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mPermutations" }, "metric_labels": { "description": "Events to Metrics metric labels", "type": "array", "items": { "$ref": "#/components/schemas/ApisEvents2metricsV2MetricLabel" }, "minItems": 0, "maxItems": 4096 }, "metric_fields": { "description": "Events to Metrics metric fields", "type": "array", "items": { "$ref": "#/components/schemas/ApisEvents2metricsV2MetricField" }, "minItems": 0, "maxItems": 10 }, "type": { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mType" }, "is_internal": { "example": true, "description": "A flag that represents if the Events to Metrics is for internal usage", "type": "boolean" } }, "required": [ "name", "type" ], "oneOf": [ { "$ref": "#/components/schemas/ApisEvents2metricsV2E2mQueryLogsQuery" } ] }, "Event2MetricCollection": { "example": { "events2metrics": [ { "create_time": "2024-03-11T10:38:21.000Z", "description": "Test Events to Metrics updated", "id": "93bde7ad-651f-48f5-96dd-e7d6b2c2a9de", "is_internal": true, "logs_query": { "lucene": "logs" }, "name": "test em2", "permutations": { "limit": 1 }, "type": "logs2metrics", "update_time": "2024-03-11T10:38:21.000Z" } ] }, "description": "Represents response of Events to Metrics collection.", "type": "object", "properties": { "events2metrics": { "description": "List of event to metrics definitions", "type": "array", "items": { "$ref": "#/components/schemas/Event2Metric" }, "minItems": 0, "maxItems": 4096 } } }, "ExtensionsV1TargetDomain": { "example": "alert_definition", "description": "The domain of the Extension item.", "type": "string", "enum": [ "alert_definition", "alert", "enrichment", "rule_group", "view", "dashboard", "events_to_metrics" ] }, "ExtensionsV1ExtensionItem": { "title": "Extension item", "description": "The Extension items included in this revision.", "type": "object", "properties": { "id": { "description": "The ID of the Extension item.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "name": { "description": "The name of the Extension item.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "description": "The detailed description of the Extension item.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "target_domain": { "$ref": "#/components/schemas/ExtensionsV1TargetDomain" }, "is_mandatory": { "example": false, "description": "A flag to indicate if the Extension item is mandatory or not. Mandatory items must be specified when deploying the Extension.", "type": "boolean" } }, "required": [ "id", "name", "target_domain" ] }, "ExtensionsV1ExtensionRevision": { "title": "Extension revision", "description": "The list of all revisions of the Extension, each representing a versioned snapshot of the Extension's functionality and appearance.", "type": "object", "properties": { "version": { "description": "The version identifier for this revision of the Extension.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "description": "The detailed description of what this revision includes, changes made, and any important information users should be aware of.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "excerpt": { "description": "The brief summary or excerpt of the Extension's description for quick reference.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "labels": { "example": [], "description": "The list of labels or tags associated with the Extension for front-end categorization and filtering.", "type": "array", "items": { "example": [], "description": "The list of labels or tags associated with the Extension for front-end categorization and filtering.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "items": { "example": [], "description": "The Extension items included in this revision.", "type": "array", "items": { "$ref": "#/components/schemas/ExtensionsV1ExtensionItem" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "version" ] }, "ExtensionsV1ChangelogEntry": { "title": "Changelog entry", "description": "The of changelog entries made in each version of the Extension.", "type": "object", "properties": { "version": { "description": "The version of the Extension this changelog entry refers to.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description_md": { "description": "The description of the changes made in this version, formatted in Markdown for rich text presentation.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}\\r\\n\\t]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "version", "description_md" ] }, "ExtensionsV1Deprecation": { "title": "Deprecation", "description": "Deprecation details of the Extension.", "type": "object", "properties": { "reason": { "description": "The reason why the element (e.g., an Extension or a version of it) is being deprecated.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}\\r\\n\\t]+$", "minLength": 1, "maxLength": 4096 }, "replacement_extensions": { "example": [], "description": "The list of Extension IDs that serve as replacements for the deprecated element.", "type": "array", "items": { "example": [], "description": "The list of Extension IDs that serve as replacements for the deprecated element.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } }, "required": [ "reason" ] }, "ExtensionDeployment": { "title": "Extension deployment", "description": "Deployment details of an Extension scoped by extension ID in the path.", "example": { "version": "1.0.0", "item_ids": [ "b9a5500c-715e-4ead-9bbe-56fdefffbfcd", "17bf6c1d-7869-48ba-9c46-96721d5e2603", "2d38545a-417c-4143-acb9-02c721d6312d", "a686e964-c0dc-453a-a124-508f91883d0d", "4082355b-5e40-4964-8578-52eb0e2e4037", "66aa7da8-d36e-49ee-b357-3424a1d4c3de" ], "applications": [ "ltest_0401" ], "subsystems": [ "ltest_0401" ] }, "type": "object", "properties": { "version": { "description": "The version of the Extension revision to deploy.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "item_ids": { "example": [ "b9a5500c-715e-4ead-9bbe-56fdefffbfcd" ], "description": "The list of Extension item IDs to deploy.", "type": "array", "items": { "example": "b9a5500c-715e-4ead-9bbe-56fdefffbfcd", "description": "The list of Extension item IDs to deploy.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 4096 }, "applications": { "example": [ "ltest_0401" ], "description": "Applications that the Extension is deployed for. When this is empty, it is applied to all applications.", "type": "array", "items": { "example": "ltest_0401", "description": "Applications that the Extension is deployed for. When this is empty, it is applied to all applications.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "subsystems": { "example": [ "ltest_0401" ], "description": "Subsystems that the Extension is deployed. When this is empty, it is applied to all subsystems.", "type": "array", "items": { "example": "ltest_0401", "description": "Subsystems that the Extension is deployed. When this is empty, it is applied to all subsystems.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 } }, "required": [ "version", "item_ids" ] }, "ExtensionsV1UndeployExtensionResponseFailedItem": { "title": "Failed item", "description": "An extension item that failed to undeploy.", "type": "object", "properties": { "item_id": { "description": "The ID of the item that failed to undeploy.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "reason": { "description": "The reason of the failure.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "item_id", "reason" ] }, "UndeployExtensionResponse": { "title": "Delete deployment of an extension response", "description": "Response for undeploying an Extension.", "type": "object", "properties": { "failed_items": { "example": [], "description": "The list of failed items.", "type": "array", "items": { "$ref": "#/components/schemas/ExtensionsV1UndeployExtensionResponseFailedItem" }, "minItems": 0, "maxItems": 4096 } } }, "Extension": { "title": "Extension metadata", "description": "Response model for a given extension.", "example": { "id": "IBMCloudKubernetes", "name": "IBM Cloud Kubernetes Service", "revisions": [ { "version": "1.0.0", "description": "IBM Cloud Kubernetes Service. The dashboard provides an in-depth analysis of IBM Cloud Kubernetes Service, offering a comprehensive view of cluster performance, node activity, pod logs, and error analysis. It enables quick issue identification, trend analysis, and efficient Kubernetes monitoring.", "excerpt": "", "labels": [ "IBM", "Kubernetes", "Cluster", "K8S", "Cloud", "Compute", "Observability" ], "items": [ { "id": "17bf6c1d-7869-48ba-9c46-96721d5e2603", "name": "IBM Kubernetes - No logs from service", "description": "No logs have been received from the kubernetes service, indicating potential issues with logging configuration, service downtime, or connectivity problems affecting log transmission.", "target_domain": "alert" }, { "id": "2d38545a-417c-4143-acb9-02c721d6312d", "name": "IBM Kubernetes - More than 5 erroneous cluster logs within 15 minutes", "description": "Over five error logs have been recorded at the cluster level within a 15-minute window, indicating potential issues affecting the Kubernetes cluster's overall health or configuration.", "target_domain": "alert" }, { "id": "a686e964-c0dc-453a-a124-508f91883d0d", "name": "IBM Kubernetes - More than 5 erroneous pod logs within 15 minutes", "description": "More than five error logs have been detected in pod-level operations within 15 minutes, suggesting issues with workloads or pod-level configurations.", "target_domain": "alert" }, { "id": "4082355b-5e40-4964-8578-52eb0e2e4037", "name": "IBM Kubernetes - Host change", "description": "A host change event has been detected, which might indicate a node replacement, scaling operation, or unexpected infrastructure changes.", "target_domain": "alert" }, { "id": "66aa7da8-d36e-49ee-b357-3424a1d4c3de", "name": "IBM Kubernetes - Permission denied", "description": "A permission denial has occurred during a Kubernetes operation, possibly caused by misconfigured access controls or insufficient permissions for the requested action.", "target_domain": "alert" }, { "id": "b9a5500c-715e-4ead-9bbe-56fdefffbfcd", "name": "IBM Kubernetes", "description": "Dashboard for IBM Cloud Kubernetes Service.", "target_domain": "dashboard" } ] } ], "changelog": [ { "version": "1.0.0", "description_md": "Changed\nRelease of an extension for the IBM Cloud Kubernetes Service." } ], "deployment": { "version": "1.0.0", "item_ids": [ "b9a5500c-715e-4ead-9bbe-56fdefffbfcd", "17bf6c1d-7869-48ba-9c46-96721d5e2603" ], "applications": [ "ltest_0401" ], "subsystems": [ "ltest_0401" ] } }, "type": "object", "properties": { "id": { "description": "The ID of the Extension.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "name": { "description": "The name of the Extension.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "revisions": { "example": [], "description": "The list of all revisions of the Extension, each representing a versioned snapshot of the Extension's functionality and appearance.", "type": "array", "items": { "$ref": "#/components/schemas/ExtensionsV1ExtensionRevision" }, "minItems": 0, "maxItems": 4096 }, "keywords": { "example": [], "description": "The list of keywords to enhance search capabilities on the front-end side.", "type": "array", "items": { "example": [], "description": "The list of keywords to enhance search capabilities on the front-end side.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 0, "maxItems": 4096 }, "changelog": { "example": [], "description": "The of changelog entries made in each version of the Extension.", "type": "array", "items": { "$ref": "#/components/schemas/ExtensionsV1ChangelogEntry" }, "minItems": 0, "maxItems": 4096 }, "deployment": { "$ref": "#/components/schemas/ExtensionDeployment" }, "deprecation": { "$ref": "#/components/schemas/ExtensionsV1Deprecation" } }, "required": [ "id", "name" ] }, "ExtensionCollection": { "title": "Get list of extensions response", "description": "Response for getting all Extensions.", "example": { "extensions": [ { "id": "IBMCloudKubernetes", "name": "IBM Cloud Kubernetes Service", "revisions": [ { "version": "1.0.0", "description": "IBM Cloud Kubernetes Service. The dashboard provides an in-depth analysis of IBM Cloud Kubernetes Service, offering a comprehensive view of cluster performance, node activity, pod logs, and error analysis. It enables quick issue identification, trend analysis, and efficient Kubernetes monitoring.", "excerpt": "", "labels": [ "IBM", "Kubernetes", "Cluster", "K8S", "Cloud", "Compute", "Observability" ] } ] }, { "id": "Linux", "name": "Linux", "revisions": [ { "version": "2.0.4", "description": "Linux - Security Extension. Linux is a Unix-like, open source and community-developed operating system (OS) for computers, servers, mainframes, mobile devices and embedded devices. It is supported on almost every major computer platform, including x86, ARM and SPARC, making it one of the most widely supported operating systems. The Linux command is a utility of the Linux operating system. All basic and advanced tasks can be done by executing commands. The commands are executed on the Linux terminal. The terminal is a command-line interface to interact with the system, which is similar to the command prompt in the Windows OS. Commands in Linux are case-sensitive. This extension relies on OpenTelemetry log shipper to send Linux logs to IBM Cloud Logs in order to operate", "excerpt": "", "labels": [ "Security", "OS", "EDR" ] } ] } ] }, "type": "object", "properties": { "extensions": { "example": [], "description": "List of Extensions.", "type": "array", "items": { "$ref": "#/components/schemas/Extension" }, "minItems": 0, "maxItems": 4096 } } }, "DashboardFolderCollection": { "description": "The list of folders", "type": "object", "properties": { "folders": { "description": "The list of folders", "type": "array", "items": { "$ref": "#/components/schemas/DashboardFolder" }, "minItems": 0, "maxItems": 4096 } } }, "ViewFolder": { "example": { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" }, "description": "View folder", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Folder ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "My Folder", "description": "Folder name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "name" ] }, "ViewFolderCollection": { "example": { "view_folders": [ { "id": "0cd4ed54-9b59-4eef-b329-151a167e2304", "name": "My Folder" } ] }, "description": "List view's folders response", "type": "object", "properties": { "view_folders": { "description": "List of view folders", "type": "array", "items": { "$ref": "#/components/schemas/ViewFolder" }, "minItems": 0, "maxItems": 4096 } } }, "ViewFolderPrototype": { "example": { "name": "My Folder" }, "description": "Create view folder", "type": "object", "properties": { "name": { "example": "My folder", "description": "View folder name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "name" ] }, "LogDataRetentionTags": { "description": "Log data retention tags configuration. Manages the three editable archive retention tags used for log retention policies. The 'Default' tag is system-managed and cannot be modified through this API.", "type": "object", "example": { "tags": [ "Short", "Intermediate", "Long" ] }, "properties": { "tags": { "description": "List of editable archive retention tags, excluding non-editable tags such as Default.", "type": "array", "items": { "description": "Editable archive retention tag name.", "type": "string", "pattern": "^[a-zA-Z0-9_-]+$", "minLength": 1, "maxLength": 256 }, "minItems": 3, "maxItems": 3, "example": [ "Short", "Intermediate", "Long" ] } }, "required": [ "tags" ] }, "OutgoingWebhooksV1WebhookType": { "example": "ibm_event_notifications", "description": "The type of the deployed outbound integrations to list.", "type": "string", "enum": [ "ibm_event_notifications" ] }, "OutgoingWebhookSummary": { "description": "The list of deployed Outbound Integrations.", "type": "object", "properties": { "id": { "example": "585bea36-bdd1-4bfb-9a26-51f1f8a12660", "description": "The ID of the outbound integration.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Event Notifications Integration", "description": "The name of the outbound integration.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "url": { "example": "https://example.com", "description": "The URL of the outbound integration. This value is null for IBM Events Notifications integration.", "type": "string", "format": "url", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "created_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The time the outbound integration was created.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "updated_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The time the outbound integration was updated.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "external_id": { "example": 123, "description": "The external ID of the outbound integration. This ID is used as integration_id for the notification configuration in Alerts", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "name", "created_at", "updated_at", "external_id" ] }, "OutgoingWebhookCollection": { "description": "Response format of outbound integrations List of a specified type.", "type": "object", "properties": { "outgoing_webhooks": { "description": "The list of deployed Outbound Integrations.", "type": "array", "items": { "$ref": "#/components/schemas/OutgoingWebhookSummary" }, "minItems": 0, "maxItems": 4096 } } }, "OutgoingWebhooksV1IbmEventNotificationsConfigEndpointType": { "example": "private", "description": "The integration endpoint type", "type": "string", "enum": [ "default_or_public", "private" ] }, "OutgoingWebhooksV1IbmEventNotificationsConfig": { "description": "The configuration of the IBM Event Notifications outbound integration.", "type": "object", "properties": { "event_notifications_instance_id": { "example": "585bea36-bdd1-4bfb-9a26-51f1f8a12660", "description": "The ID of the selected IBM Event Notifications instance.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "region_id": { "example": "eu-es", "description": "The region ID of the selected IBM Event Notifications instance.", "type": "string", "pattern": "^[a-z]{2}-[a-z]+$", "minLength": 4, "maxLength": 4096 }, "source_id": { "example": "crn:v1:staging:public:logs:eu-gb:a/223af6f4260f42ebe23e95fcddd33cb7:63a3e4be-cb73-4f52-898e-8e93484a70a5::", "description": "The ID of the created source in the IBM Event Notifications instance. Corresponds to the Cloud Logs instance crn. Not required when creating an outbound integration.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "source_name": { "example": "IBM Cloud Event Notifications", "description": "The name of the created source in the IBM Event Notifications instance. Not required when creating an outbound integration.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "endpoint_type": { "$ref": "#/components/schemas/OutgoingWebhooksV1IbmEventNotificationsConfigEndpointType" } }, "required": [ "event_notifications_instance_id", "region_id" ] }, "OutgoingWebhooksV1OutgoingWebhookConfigIbmEventNotifications": { "type": "object", "properties": { "ibm_event_notifications": { "$ref": "#/components/schemas/OutgoingWebhooksV1IbmEventNotificationsConfig" } } }, "OutgoingWebhook": { "description": "The outbound integration", "properties": { "id": { "example": "585bea36-bdd1-4bfb-9a26-51f1f8a12660", "description": "The ID of the outbound integration.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "type": { "$ref": "#/components/schemas/OutgoingWebhooksV1WebhookType" }, "name": { "example": "Event Notifications Integration", "description": "The name of the outbound integration.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "url": { "example": "https://example.com", "description": "The URL of the outbound integration. This value is null for IBM Events Notifications integration.", "type": "string", "format": "url", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "created_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The time the outbound integration was created.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "updated_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The time the outbound integration was updated.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "external_id": { "example": 123, "description": "The external ID of the outbound integration. This ID is used as integration_id for the notification configuration in Alerts", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "type", "name", "created_at", "updated_at", "external_id" ], "oneOf": [ { "$ref": "#/components/schemas/OutgoingWebhooksV1OutgoingWebhookConfigIbmEventNotifications" } ] }, "OutgoingWebhooksV1OutgoingWebhookInputDataConfigIbmEventNotifications": { "type": "object", "properties": { "ibm_event_notifications": { "$ref": "#/components/schemas/OutgoingWebhooksV1IbmEventNotificationsConfig" } } }, "OutgoingWebhookPrototype": { "description": "The input data of the outbound integration.", "properties": { "type": { "$ref": "#/components/schemas/OutgoingWebhooksV1WebhookType" }, "name": { "example": "Event Notifications Integration", "description": "The name of the outbound integration.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "url": { "example": "https://example.com", "description": "The URL of the outbound integration. This value is null for IBM Events Notifications integration.", "type": "string", "format": "url", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "type", "name" ], "oneOf": [ { "$ref": "#/components/schemas/OutgoingWebhooksV1OutgoingWebhookInputDataConfigIbmEventNotifications" } ] }, "QuotaV1Severity": { "example": "critical", "description": "The source severities to be used when matching", "type": "string", "enum": [ "debug", "verbose", "info", "warning", "error", "critical" ] }, "QuotaV1LogRules": { "description": "Log rules", "type": "object", "properties": { "severities": { "example": [ "critical" ], "description": "The source severities to be used when matching", "type": "array", "items": { "$ref": "#/components/schemas/QuotaV1Severity" }, "minItems": 0, "maxItems": 4096 } } }, "QuotaV1PolicySourceTypeRulesLogRules": { "type": "object", "properties": { "log_rules": { "$ref": "#/components/schemas/QuotaV1LogRules" } } }, "QuotaV1Priority": { "example": "type_high", "description": "The data pipeline sources that match the policy rules will continue to be processed by Cloud Logs", "type": "string", "enum": [ "type_unspecified", "type_block", "type_low", "type_medium", "type_high" ] }, "QuotaV1RuleTypeId": { "example": "includes", "description": "Identifier of the rule", "type": "string", "enum": [ "unspecified", "is", "is_not", "start_with", "includes" ] }, "QuotaV1Rule": { "description": "Rule for matching the application name", "type": "object", "properties": { "rule_type_id": { "$ref": "#/components/schemas/QuotaV1RuleTypeId" }, "name": { "example": "Rule Name", "description": "Name of the rule. Multiple values can be provided as comma separated string of values.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "rule_type_id", "name" ] }, "Policy": { "example": { "application_rule": { "name": "policy-test", "rule_type_id": "is" }, "company_id": 192, "created_at": "Tue Feb 06 2024 11:22:58 GMT+0000 (Coordinated Universal Time)", "deleted": false, "description": "Medium policy", "enabled": true, "id": "ac91d47c-faf1-4761-831d-b393f81a3fdc", "log_rules": { "severities": [ "debug", "verbose", "info", "warning", "error" ] }, "name": "Med_policy", "order": 2, "priority": "type_high", "subsystem_rule": { "name": "policy-test", "rule_type_id": "is" }, "archive_retention_tag": "Default", "updated_at": "Thu Feb 15 2024 12:30:42 GMT+0000 (Coordinated Universal Time)" }, "description": "Policy resource model", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Policy ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "before": { "$ref": "#/components/schemas/PolicyBefore" }, "company_id": { "example": 1234, "description": "Company ID", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "name": { "example": "Policy Name", "description": "Name of policy", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Policy description", "description": "Description of policy", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "priority": { "$ref": "#/components/schemas/QuotaV1Priority" }, "deleted": { "example": true, "description": "Soft deletion flag", "type": "boolean" }, "enabled": { "example": true, "description": "Flag to enable or disable a policy. This flag is supported only while updating a policy, since the policies are always enabled during creation.", "type": "boolean" }, "order": { "example": 1, "description": "Order of policy in relation to other policies", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "application_rule": { "$ref": "#/components/schemas/QuotaV1Rule" }, "subsystem_rule": { "$ref": "#/components/schemas/QuotaV1Rule" }, "created_at": { "example": "2023-06-21T14:24:39.000Z", "description": "Created at date at utc+0", "type": "string", "pattern": "^\"\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\"$", "minLength": 1, "maxLength": 4096 }, "updated_at": { "example": "2023-06-21T14:24:39.000Z", "description": "Updated at date at utc+0", "type": "string", "pattern": "^\"\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}\"$", "minLength": 1, "maxLength": 4096 }, "archive_retention_tag": { "example": "Default", "description": "Archive retention tag. Required when retention tags are active. Cannot be set when retention tags are not active.", "type": "string", "pattern": "^[a-zA-Z0-9_-]+$", "minLength": 1, "maxLength": 255 } }, "required": [ "id", "company_id", "name", "description", "order", "created_at", "updated_at" ], "oneOf": [ { "$ref": "#/components/schemas/QuotaV1PolicySourceTypeRulesLogRules" } ] }, "PolicyBefore": { "description": "The policy will be inserted immediately before the existing policy with this ID. If unspecified, the policy will be inserted after all existing policies.", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The policy will be inserted immediately before the existing policy with this ID. If unspecified, the policy will be inserted after all existing policies.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "My Policy", "description": "Policy name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "id" ] }, "PolicyBeforePrototype": { "description": "The policy will be inserted immediately before the existing policy with this ID. If unspecified, the policy will be inserted after all existing policies.", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The policy will be inserted immediately before the existing policy with this ID. If unspecified, the policy will be inserted after all existing policies.", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "id" ] }, "QuotaV1CreatePolicyRequestSourceTypeRulesLogRules": { "type": "object", "properties": { "log_rules": { "$ref": "#/components/schemas/QuotaV1LogRules" } } }, "PolicyPrototype": { "example": { "application_rule": { "name": "policy-test", "rule_type_id": "is" }, "deleted": false, "description": "Medium Policy", "enabled": true, "log_rules": { "severities": [ "debug", "verbose", "info", "warning", "error" ] }, "name": "Med_policy", "order": 2, "priority": "type_high", "subsystem_rule": { "name": "policy-test", "rule_type_id": "is" }, "archive_retention_tag": "Default" }, "description": "Create policy request", "properties": { "name": { "example": "My Policy", "description": "Policy name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "before": { "$ref": "#/components/schemas/PolicyBeforePrototype" }, "description": { "example": "My Policy description", "description": "Policy description", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "priority": { "$ref": "#/components/schemas/QuotaV1Priority" }, "application_rule": { "$ref": "#/components/schemas/QuotaV1Rule" }, "subsystem_rule": { "$ref": "#/components/schemas/QuotaV1Rule" }, "archive_retention_tag": { "example": "Default", "description": "Archive retention tag. Required when retention tags are active. Cannot be set when retention tags are not active.", "type": "string", "pattern": "^[a-zA-Z0-9_-]+$", "minLength": 1, "maxLength": 255 }, "enabled": { "example": true, "description": "Flag to enable or disable a policy. This flag is supported only while updating a policy, since the policies are always enabled during creation.", "default": true, "type": "boolean" } }, "required": [ "name", "priority" ], "oneOf": [ { "$ref": "#/components/schemas/QuotaV1CreatePolicyRequestSourceTypeRulesLogRules" } ] }, "QuotaV1SourceType": { "example": "logs", "description": "Source type used to filter policies", "type": "string", "enum": [ "unspecified", "logs" ] }, "PolicyCollection": { "example": { "policies": [ { "application_rule": { "name": "policy-test", "rule_type_id": "is" }, "company_id": 192, "created_at": "Tue Feb 06 2024 11:22:58 GMT+0000 (Coordinated Universal Time)", "deleted": false, "description": "Medium policy", "enabled": true, "id": "ac91d47c-faf1-4761-831d-b393f81a3fdc", "log_rules": { "severities": [ "debug", "verbose", "info", "warning", "error" ] }, "name": "Med_policy", "order": 2, "priority": "type_high", "subsystem_rule": { "name": "policy-test", "rule_type_id": "is" }, "updated_at": "Thu Feb 15 2024 12:30:42 GMT+0000 (Coordinated Universal Time)" } ] }, "description": "Get company policies response", "type": "object", "properties": { "policies": { "description": "Company policies", "type": "array", "items": { "$ref": "#/components/schemas/Policy" }, "minItems": 0, "maxItems": 4096 } } }, "ApisDataprimeV1MetadataTier": { "example": "frequent_search", "description": "Tier where the query is run", "type": "string", "enum": [ "unspecified", "archive", "frequent_search" ] }, "ApisDataprimeV1Metadata": { "description": "The query configuration", "type": "object", "properties": { "start_date": { "example": "2021-01-01T00:00:00.000Z", "description": "Beginning of the time range for the query. Default: end - 15 minutes or current time - 15 minutes if end is not defined", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "end_date": { "example": "2021-01-01T00:00:00.000Z", "description": "End of the time range for the query. Default: start + 15 minutes or current time if start is not defined", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "default_source": { "example": "logs", "description": "Default value for the source to be used when the source is omitted in a query", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "tier": { "$ref": "#/components/schemas/ApisDataprimeV1MetadataTier" }, "syntax": { "$ref": "#/components/schemas/ApisDataprimeV1QuerySyntax" }, "limit": { "example": 2000, "description": "The maximum number of results to be returned. The default is 2000 results. The max that can be specified for for TIER_FREQUENT_SEARCH is 12000. The max that can be specified for TIER_ARCHIVE is 50000.", "type": "integer", "format": "int32", "minimum": 0, "maximum": 50000 }, "strict_fields_validation": { "example": true, "description": "Prohibit the use of unknown fields, For example, those not detected in the ingested data. Default: false", "type": "boolean" }, "now_date": { "example": "2021-01-01T00:00:00.000Z", "description": "Defaults to the current system time. Used by time-based functions such as now() in DataPrime.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } } }, "QueryRequest": { "description": "Query request", "type": "object", "properties": { "query": { "example": "source logs | limit 10", "description": "The background query to be run.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "metadata": { "$ref": "#/components/schemas/ApisDataprimeV1Metadata" } }, "required": [ "query" ] }, "ApisDataprimeV1DataprimeErrorRateLimitReachedEmpty": { "description": "Rate limit reached error", "type": "object" }, "ApisDataprimeV1DataprimeErrorCode": { "description": "Error code", "type": "object", "properties": { "rate_limit_reached": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeErrorRateLimitReachedEmpty" } } }, "ApisDataprimeV1DataprimeError": { "description": "Error message", "type": "object", "properties": { "message": { "example": "Failed to run the query 1/archive/3424/4rwoNx1XNcc", "description": "Human-readable error message", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "code": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeErrorCode" } }, "required": [ "message" ] }, "ApisDataprimeV1QueryResponseMessageError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeError" } } }, "ApisDataprimeV1QueryResponseMessageResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeResult" } } }, "ApisDataprimeV1QueryResponseMessageWarning": { "type": "object", "properties": { "warning": { "$ref": "#/components/schemas/ApisDataprimeV1DataprimeWarning" } } }, "ApisDataprimeV1QueryId": { "description": "Internal identifier of the query", "type": "object", "properties": { "query_id": { "example": "4rwoNx1XNcc", "description": "Unique identifier of the query", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "query_id" ] }, "ApisDataprimeV1QueryResponseMessageQueryId": { "type": "object", "properties": { "query_id": { "$ref": "#/components/schemas/ApisDataprimeV1QueryId" } } }, "QueryResponse": { "description": "Response for a text query.", "oneOf": [ { "$ref": "#/components/schemas/ApisDataprimeV1QueryResponseMessageError" }, { "$ref": "#/components/schemas/ApisDataprimeV1QueryResponseMessageResult" }, { "$ref": "#/components/schemas/ApisDataprimeV1QueryResponseMessageWarning" }, { "$ref": "#/components/schemas/ApisDataprimeV1QueryResponseMessageQueryId" } ] }, "QueryResponseStreamItem": { "oneOf": [ { "$ref": "#/components/schemas/QueryResponse" }, { "$ref": "#/components/schemas/ApiError" } ] }, "RulesV1ApplicationNameConstraint": { "description": "ApplicationName constraint", "type": "object", "properties": { "value": { "example": "my-application", "description": "Only logs with this ApplicationName value will match the rule constraint.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "value" ] }, "RulesV1RuleMatcherConstraintApplicationName": { "type": "object", "properties": { "application_name": { "$ref": "#/components/schemas/RulesV1ApplicationNameConstraint" } } }, "RulesV1SubsystemNameConstraint": { "description": "SubsystemName constraint", "type": "object", "properties": { "value": { "example": "my-subsystem", "description": "Only logs with this SubsystemName value will match the rule constraint.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "value" ] }, "RulesV1RuleMatcherConstraintSubsystemName": { "type": "object", "properties": { "subsystem_name": { "$ref": "#/components/schemas/RulesV1SubsystemNameConstraint" } } }, "RulesV1SeverityConstraintValue": { "example": "critical", "description": "Only logs with this severity value will match", "type": "string", "enum": [ "debug_or_unspecified", "verbose", "info", "warning", "error", "critical" ] }, "RulesV1SeverityConstraint": { "description": "Severity constraint", "type": "object", "properties": { "value": { "$ref": "#/components/schemas/RulesV1SeverityConstraintValue" } }, "required": [ "value" ] }, "RulesV1RuleMatcherConstraintSeverity": { "type": "object", "properties": { "severity": { "$ref": "#/components/schemas/RulesV1SeverityConstraint" } } }, "RulesV1RuleMatcher": { "description": "Optional rule matchers. If matched, the rule is processed by the rule group.", "oneOf": [ { "$ref": "#/components/schemas/RulesV1RuleMatcherConstraintApplicationName" }, { "$ref": "#/components/schemas/RulesV1RuleMatcherConstraintSubsystemName" }, { "$ref": "#/components/schemas/RulesV1RuleMatcherConstraintSeverity" } ] }, "RulesV1ExtractParameters": { "description": "Parameters for text extraction rule", "type": "object", "properties": { "rule": { "example": "^http:\\\\/\\\\/my\\\\.service\\\\.com\\\\/#(?P\\\\w+)\\\\-(?P[^_]+)_", "description": "Regex which will parse the source field and extract the JSON keys from source field while retaining the original log", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "rule" ] }, "RulesV1RuleParametersRuleParametersExtractParameters": { "type": "object", "properties": { "extract_parameters": { "$ref": "#/components/schemas/RulesV1ExtractParameters" } } }, "RulesV1JsonExtractParametersDestinationField": { "example": "severity", "description": "The metadata field used to store the extracted value", "type": "string", "enum": [ "category_or_unspecified", "classname", "methodname", "threadid", "severity" ] }, "RulesV1JsonExtractParameters": { "description": "Parameters for JSON extract rule", "type": "object", "properties": { "destination_field": { "$ref": "#/components/schemas/RulesV1JsonExtractParametersDestinationField" }, "rule": { "example": "log.elb_status_code", "description": "Regex which will extract a JSON parameter from the source field", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "destination_field", "rule" ] }, "RulesV1RuleParametersRuleParametersJsonExtractParameters": { "type": "object", "properties": { "json_extract_parameters": { "$ref": "#/components/schemas/RulesV1JsonExtractParameters" } } }, "RulesV1ReplaceParameters": { "description": "Parameters for replace rule", "type": "object", "properties": { "destination_field": { "example": "text.message", "description": "The field used to store the modified text", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "replace_new_val": { "example": "***", "description": "The value replacing the matched text.", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 }, "rule": { "example": "the password is (?P[\\p{L}0-9!@#$].)", "description": "Regex which will match parts in the text to replace", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "destination_field", "replace_new_val", "rule" ] }, "RulesV1RuleParametersRuleParametersReplaceParameters": { "type": "object", "properties": { "replace_parameters": { "$ref": "#/components/schemas/RulesV1ReplaceParameters" } } }, "RulesV1ParseParameters": { "description": "Parameters for parse rule", "type": "object", "properties": { "destination_field": { "example": "text.message", "description": "The field to store the parsed text", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "rule": { "example": "^http:\\/\\/my\\.service\\.com\\/#(?P\\w+)\\-(?P[^_]+)$", "description": "Regex which will parse the source field and extract the JSON keys from it while removing the source field", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "destination_field", "rule" ] }, "RulesV1RuleParametersRuleParametersParseParameters": { "type": "object", "properties": { "parse_parameters": { "$ref": "#/components/schemas/RulesV1ParseParameters" } } }, "RulesV1AllowParameters": { "description": "Parameters for the allow rule", "type": "object", "properties": { "keep_blocked_logs": { "example": true, "description": "If true, matched logs will be blocked, otherwise matched logs will be kept", "type": "boolean" }, "rule": { "example": "^this log will be kept!!!.*$", "description": "Regex which will match the source field and decide if the rule will apply", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "keep_blocked_logs", "rule" ] }, "RulesV1RuleParametersRuleParametersAllowParameters": { "type": "object", "properties": { "allow_parameters": { "$ref": "#/components/schemas/RulesV1AllowParameters" } } }, "RulesV1BlockParameters": { "description": "Parameters for block rule", "type": "object", "properties": { "keep_blocked_logs": { "example": true, "description": "If true, matched logs will be kept, otherwise matched logs will be blocked", "type": "boolean" }, "rule": { "example": "^this log will be blocked!!!.*$", "description": "Regex which will match the source field and decide if the rule will apply", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "keep_blocked_logs", "rule" ] }, "RulesV1RuleParametersRuleParametersBlockParameters": { "type": "object", "properties": { "block_parameters": { "$ref": "#/components/schemas/RulesV1BlockParameters" } } }, "RulesV1ExtractTimestampParametersFormatStandard": { "example": "nanots", "description": "The time format to be used for the extracted time value", "type": "string", "enum": [ "strftime_or_unspecified", "javasdf", "golang", "secondsts", "millits", "microts", "nanots" ] }, "RulesV1ExtractTimestampParameters": { "description": "Parameters for extract timestamp rule", "type": "object", "properties": { "standard": { "$ref": "#/components/schemas/RulesV1ExtractTimestampParametersFormatStandard" }, "format": { "example": "%Y-%m-%ddT%H:%M:%S.%f%z", "description": "The time format of the source field being extracted.", "type": "string", "pattern": "^.*$", "minLength": 1, "maxLength": 4096 } }, "required": [ "standard", "format" ] }, "RulesV1RuleParametersRuleParametersExtractTimestampParameters": { "type": "object", "properties": { "extract_timestamp_parameters": { "$ref": "#/components/schemas/RulesV1ExtractTimestampParameters" } } }, "RulesV1RemoveFieldsParameters": { "description": "Parameters for the remove fields rule", "type": "object", "properties": { "fields": { "example": [ "json.field1", "json.field2" ], "description": "Json field paths to drop from the log", "type": "array", "items": { "description": "Json field paths to drop from the log", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "minItems": 1, "maxItems": 4096 } }, "required": [ "fields" ] }, "RulesV1RuleParametersRuleParametersRemoveFieldsParameters": { "type": "object", "properties": { "remove_fields_parameters": { "$ref": "#/components/schemas/RulesV1RemoveFieldsParameters" } } }, "RulesV1JsonStringifyParameters": { "description": "Parameters for JSON stringify rule", "type": "object", "properties": { "destination_field": { "example": "json.stringified", "description": "The destination field where the JSON stringified content will be placed.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "delete_source": { "example": true, "description": "Whether or not to delete the source field after running this rule", "type": "boolean" } }, "required": [ "destination_field" ] }, "RulesV1RuleParametersRuleParametersJsonStringifyParameters": { "type": "object", "properties": { "json_stringify_parameters": { "$ref": "#/components/schemas/RulesV1JsonStringifyParameters" } } }, "RulesV1JsonParseParameters": { "description": "Parameters for JSON parse rule", "type": "object", "properties": { "destination_field": { "example": "json.content", "description": "Destination field where the JSON object will be placed.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "delete_source": { "example": true, "description": "Whether or not to delete the source field after running this rule", "type": "boolean" }, "override_dest": { "example": true, "description": "The destination field where the JSON stringified content will be placed.", "type": "boolean" } }, "required": [ "destination_field", "override_dest" ] }, "RulesV1RuleParametersRuleParametersJsonParseParameters": { "type": "object", "properties": { "json_parse_parameters": { "$ref": "#/components/schemas/RulesV1JsonParseParameters" } } }, "RulesV1RuleParameters": { "description": "Parameters specifying how a rule runs", "oneOf": [ { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersExtractParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersJsonExtractParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersReplaceParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersParseParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersAllowParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersBlockParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersExtractTimestampParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersRemoveFieldsParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersJsonStringifyParameters" }, { "$ref": "#/components/schemas/RulesV1RuleParametersRuleParametersJsonParseParameters" } ] }, "RulesV1Rule": { "description": "Rules to run on the log", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "Unique identifier of the rule", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "Extract service and region", "description": "Name of the rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 255 }, "description": { "example": "Extracts the service and region from the source field", "description": "Description of the rule", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "source_field": { "example": "logObj.source", "description": "The field value used to execute the rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "parameters": { "$ref": "#/components/schemas/RulesV1RuleParameters" }, "enabled": { "example": true, "description": "Whether or not to execute the rule", "type": "boolean" }, "order": { "example": 1, "description": "The ordering of the rule subgroup. Lower order will run first. 0 is considered as no value", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "id", "name", "source_field", "parameters", "enabled", "order" ] }, "RulesV1RuleSubgroup": { "description": "Rule subgroups. The first rule subgroup will be executed first. If there is no match, subsequent rule groups will be attempted until there is a match. Rule groups are attempted in order.", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The ID of the rule subgroup", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "rules": { "description": "Rules to run on the log", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1Rule" }, "minItems": 1, "maxItems": 4096 }, "enabled": { "example": true, "description": "Whether or not the rule subgroup is enabled", "type": "boolean" }, "order": { "example": 1, "description": "The ordering of the rule subgroup. Lower order will run first. 0 is considered as no value", "type": "integer", "format": "int64", "minimum": 1, "maximum": 4294967295 } }, "required": [ "id", "rules", "order" ] }, "RuleGroup": { "example": { "description": "mysql audit logs parser", "enabled": true, "hidden": false, "id": "dae394d9-027a-4f95-a441-c7f3d4ea857d", "name": "mysql-extractrule", "order": 39, "rule_matchers": [ { "subsystem_name": { "value": "mysql" } } ], "rule_subgroups": [ { "enabled": true, "id": "7a4770de-b2db-4e68-a891-68a43e9fea3c", "order": 1, "rules": [ { "description": "mysql-parse", "enabled": true, "id": "d032de36-1dd2-410d-a992-fc150337df83", "name": "mysql-parse", "order": 1, "parameters": { "parse_parameters": { "destination_field": "text", "rule": "(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)" } }, "source_field": "text" } ] } ] }, "description": "Parsing rule group", "type": "object", "properties": { "id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "The ID of the rule group", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "name": { "example": "rule group", "description": "The name of the rule group", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 255 }, "description": { "example": "Rule group to extract severity from logs", "description": "A description of the rule group. The description will describe the purpose of the rule group.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "enabled": { "example": true, "description": "Whether or not the rule is enabled", "type": "boolean" }, "rule_matchers": { "description": "Optional rule matchers which, if matched, will process the rule through the rule group", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1RuleMatcher" }, "minItems": 0, "maxItems": 4096 }, "rule_subgroups": { "description": "Rule subgroups. The first rule subgroup will be executed first. If there is no match, subsequent rule groups will be attempted until there is a match. Rule groups are attempted in order.", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1RuleSubgroup" }, "minItems": 1, "maxItems": 4096 }, "order": { "example": 1, "description": "The order in which the rule group will be evaluated. The lower the order, the more priority the group will have. Not providing the order will, by default, create a group with the last order.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 4294967295 } }, "required": [ "id", "name", "rule_subgroups" ] }, "RuleGroupCollection": { "example": { "rulegroups": [ { "description": "mysql audit logs parser", "enabled": true, "hidden": false, "id": "a2ddf5dd-f77f-4bea-b782-4068c510e15d", "name": "mysql-extractrule", "order": 5, "rule_matchers": [ { "subsystem_name": { "value": "mysql" } } ], "rule_subgroups": [ { "enabled": true, "id": "2df585fe-be27-4062-aa42-e740193bfc75", "order": 1, "rules": [ { "description": "mysql-parse", "enabled": true, "id": "bd585f17-278a-4908-b05b-54fd6bf693be", "name": "mysql-parse", "order": 1, "parameters": { "parse_parameters": { "destination_field": "text", "rule": "(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)" } }, "source_field": "text" } ] } ] } ] }, "description": "Response model for ListRuleGroups rpc", "type": "object", "properties": { "rulegroups": { "description": "The rule groups", "type": "array", "items": { "$ref": "#/components/schemas/RuleGroup" }, "minItems": 0, "maxItems": 4096 } } }, "RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule": { "description": "Rules to run on the log", "type": "object", "properties": { "name": { "example": "Extract Timestamp", "description": "Optional rule name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "description": { "example": "Extract timestamp with ISO format for Mysql logs", "description": "Optional description for the rule", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "source_field": { "example": "log_obj.date_time", "description": "The field on which to execute the rule", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "parameters": { "$ref": "#/components/schemas/RulesV1RuleParameters" }, "enabled": { "example": true, "description": "Rule parameters which define how the rule will execute", "type": "boolean" }, "order": { "example": 1, "description": "The order the rule will execute inside the rule subgroup.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "source_field", "parameters", "enabled", "order" ] }, "RulesV1CreateRuleGroupRequestCreateRuleSubgroup": { "description": "Rule subgroups. The first rule subgroup will be executed first. If there is no match, subsequent rule groups will be attempted until there is a match. Rule groups are attempted in order.", "type": "object", "properties": { "rules": { "description": "Rules to run on the log", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1CreateRuleGroupRequestCreateRuleSubgroupCreateRule" }, "minItems": 1, "maxItems": 4096 }, "enabled": { "example": true, "description": "Whether or not the rule subgroup is enabled", "type": "boolean" }, "order": { "example": 1, "description": "The ordering of the rule subgroup. Lower order will run first. 0 is considered as no value", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "rules", "order" ] }, "RuleGroupPrototype": { "example": { "description": "mysql audit logs parser", "enabled": true, "hidden": false, "name": "mysql-extractrule", "order": 39, "rule_matchers": [ { "subsystem_name": { "value": "mysql" } } ], "rule_subgroups": [ { "enabled": true, "order": 1, "rules": [ { "description": "mysql-parse", "enabled": true, "name": "mysql-parse", "order": 1, "parameters": { "parse_parameters": { "destination_field": "text", "rule": "(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[^,]+),(?P[0-9]+),(?P[0-9]+),(?P[^,]+),(?P[^,]+),'?(?P.*)'?,(?P[0-9]+)" } }, "source_field": "text" } ] } ] }, "description": "Request model to create or update a rule group", "type": "object", "properties": { "name": { "example": "rule group", "description": "The name of the rule group", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 255 }, "description": { "example": "Rule group to extract severity from logs", "description": "A description of the rule group. The description will describe the purpose of the rule group.", "type": "string", "pattern": "^[\\p{L}0-9_\\-\\s]+$", "minLength": 1, "maxLength": 4096 }, "enabled": { "example": true, "description": "Whether or not the rule is enabled", "type": "boolean" }, "rule_matchers": { "description": "Optional rule matchers which, if matched, will process the rule through the rule group", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1RuleMatcher" }, "minItems": 0, "maxItems": 4096 }, "rule_subgroups": { "description": "Rule subgroups. The first rule subgroup will be executed first. If there is no match, subsequent rule groups will be attempted until there is a match. Rule groups are attempted in order.", "type": "array", "items": { "$ref": "#/components/schemas/RulesV1CreateRuleGroupRequestCreateRuleSubgroup" }, "minItems": 1, "maxItems": 4096 }, "order": { "example": 1, "description": "The order in which the rule group will be evaluated. The lower the order, the more priority the group will have. Not providing the order will, by default, create a group with the last order.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "name", "rule_subgroups" ] }, "IbmEventStreams": { "description": "Configuration for IBM Event Streams.", "type": "object", "properties": { "brokers": { "example": "kafka01.example.com:9093", "description": "The brokers of the IBM Event Streams. Multiple broker endpoints can be provided as comma separated values.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "topic": { "example": "live.screen", "description": "The topic of the IBM Event Streams.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 } }, "required": [ "brokers", "topic" ] }, "StreamCompressionType": { "example": "gzip", "description": "The compression type of the stream.", "type": "string", "enum": [ "unspecified", "gzip" ] }, "Stream": { "example": { "compression_type": "gzip", "created_at": "2024-08-27T10:06:46.363Z", "dpxl_expression": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "ibm_event_streams": { "brokers": "kafka01.example.com:9093", "topic": "live.screen" }, "id": 102, "is_active": false, "name": "Live Screen", "updated_at": "2024-08-27T10:06:46.363Z" }, "description": "The Event Stream.", "properties": { "id": { "description": "The ID of the Event stream.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 }, "name": { "example": "Live Screen", "description": "The name of the Event stream.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "is_active": { "example": true, "description": "Whether the event stream is active.", "type": "boolean" }, "dpxl_expression": { "example": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "description": "The DPXL expression of the Event stream.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "created_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The creation time of the Event stream.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "updated_at": { "example": "2021-01-01T00:00:00.000Z", "description": "The update time of the Event stream.", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "compression_type": { "$ref": "#/components/schemas/StreamCompressionType" }, "ibm_event_streams": { "$ref": "#/components/schemas/IbmEventStreams" } }, "required": [ "name", "dpxl_expression" ] }, "StreamCollection": { "example": { "streams": [ { "compression_type": "gzip", "created_at": "2024-08-27T10:06:46.000Z", "dpxl_expression": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "ibm_event_streams": { "brokers": "kafka01.example.com:9093", "topic": "live.screen" }, "id": 102, "is_active": false, "name": "Live Screen", "updated_at": "2024-08-27T10:06:46.000Z" } ] }, "description": "List of event streams.", "type": "object", "properties": { "streams": { "description": "List of event streams.", "type": "array", "items": { "$ref": "#/components/schemas/Stream" }, "minItems": 0, "maxItems": 4096 } }, "required": [ "streams" ] }, "StreamPrototype": { "example": { "compression_type": "gzip", "dpxl_expression": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "ibm_event_streams": { "brokers": "kafka01.example.com:9093", "topic": "live.screen" }, "is_active": false, "name": "Live Screen" }, "description": "The Event Stream.", "properties": { "name": { "example": "Live Screen", "description": "The name of the Event stream.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "is_active": { "example": true, "description": "Whether the event stream is active.", "type": "boolean" }, "dpxl_expression": { "example": "contains(kubernetes.labels.CX_AZ, 'eu-west-1')", "description": "The DPXL expression of the Event stream.", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "compression_type": { "$ref": "#/components/schemas/StreamCompressionType" }, "ibm_event_streams": { "$ref": "#/components/schemas/IbmEventStreams" } }, "required": [ "name", "dpxl_expression" ] }, "ApisViewsV1SyntaxType": { "description": "Syntax type for the query used in views.", "example": "dataprime", "type": "string", "enum": [ "lucene", "dataprime" ] }, "ApisViewsV1ViewType": { "description": "Type of view", "example": "archive_templates", "type": "string", "enum": [ "priority_insights", "priority_insights_templates", "all_logs", "all_logs_templates" ] }, "ApisViewsV1SearchQuery": { "description": "View search query", "type": "object", "properties": { "query": { "example": "error", "description": "View search query", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "syntax_type": { "$ref": "#/components/schemas/ApisViewsV1SyntaxType" } }, "required": [ "query" ] }, "ApisViewsV1QuickTimeSelection": { "description": "Quick time selection", "type": "object", "properties": { "caption": { "example": "Last hour", "description": "Quick time selection caption", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "seconds": { "example": 3600, "description": "Quick time selection amount in seconds", "type": "integer", "format": "int64", "minimum": 0, "maximum": 4294967295 } }, "required": [ "caption", "seconds" ] }, "ApisViewsV1TimeSelectionSelectionTypeQuickSelection": { "type": "object", "properties": { "quick_selection": { "$ref": "#/components/schemas/ApisViewsV1QuickTimeSelection" } } }, "ApisViewsV1CustomTimeSelection": { "description": "Custom time selection", "type": "object", "properties": { "from_time": { "example": "2024-01-25T11:31:43.152Z", "description": "Custom time selection starting timestamp", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 }, "to_time": { "example": "2024-01-25T11:35:43.152Z", "description": "Custom time selection ending timestamp", "type": "string", "format": "date-time", "minLength": 20, "maxLength": 29 } }, "required": [ "from_time", "to_time" ] }, "ApisViewsV1TimeSelectionSelectionTypeCustomSelection": { "type": "object", "properties": { "custom_selection": { "$ref": "#/components/schemas/ApisViewsV1CustomTimeSelection" } } }, "ApisViewsV1TimeSelection": { "description": "View time selection", "oneOf": [ { "$ref": "#/components/schemas/ApisViewsV1TimeSelectionSelectionTypeQuickSelection" }, { "$ref": "#/components/schemas/ApisViewsV1TimeSelectionSelectionTypeCustomSelection" } ] }, "SelectedValuesEntry": { "example": { "cs-rest-test1": true, "demo": true }, "description": "Filter selected values", "type": "object", "additionalProperties": { "example": true, "type": "boolean" } }, "ApisViewsV1Filter": { "description": "Selected filters", "type": "object", "properties": { "name": { "example": "applicationName", "description": "Filter name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "selected_values": { "$ref": "#/components/schemas/SelectedValuesEntry" } }, "required": [ "name" ] }, "ApisViewsV1SelectedFilters": { "description": "View selected filters", "type": "object", "properties": { "filters": { "description": "Selected filters", "type": "array", "items": { "$ref": "#/components/schemas/ApisViewsV1Filter" }, "minItems": 1, "maxItems": 4096 } } }, "ViewPrototype": { "example": { "filters": { "filters": [ { "name": "applicationName", "selected_values": { "demo": true } }, { "name": "subsystemName", "selected_values": { "demo": true } }, { "name": "operationName", "selected_values": { "demo": true } }, { "name": "serviceName", "selected_values": { "demo": true } }, { "name": "severity", "selected_values": { "demo": true } } ] }, "name": "Logs view", "search_query": { "query": "logs" }, "time_selection": { "custom_selection": { "from_time": "2024-01-25T11:31:43.152Z", "to_time": "2024-01-25T11:37:13.238Z" } } }, "description": "Request to create or update a view", "type": "object", "properties": { "name": { "example": "Logs view", "description": "View name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "search_query": { "$ref": "#/components/schemas/ApisViewsV1SearchQuery" }, "time_selection": { "$ref": "#/components/schemas/ApisViewsV1TimeSelection" }, "filters": { "$ref": "#/components/schemas/ApisViewsV1SelectedFilters" }, "folder_id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "View folder ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "tier": { "$ref": "#/components/schemas/ApisViewsV1ViewType" } }, "required": [ "name", "time_selection" ] }, "View": { "example": { "filters": { "filters": [ { "name": "applicationName", "selected_values": { "demo": true } }, { "name": "subsystemName", "selected_values": { "demo": true } }, { "name": "operationName", "selected_values": { "demo": true } }, { "name": "serviceName", "selected_values": { "demo": true } }, { "name": "severity", "selected_values": { "demo": true } } ] }, "id": 52, "name": "Logs view", "search_query": { "query": "logs" }, "time_selection": { "custom_selection": { "from_time": "2024-01-25T11:31:43.152Z", "to_time": "2024-01-25T11:37:13.238Z" } } }, "description": "View", "type": "object", "properties": { "id": { "example": 52, "description": "View ID", "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "name": { "example": "Logs view", "description": "View name", "type": "string", "pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}\\p{S}\\p{M}]+$", "minLength": 1, "maxLength": 4096 }, "search_query": { "$ref": "#/components/schemas/ApisViewsV1SearchQuery" }, "time_selection": { "$ref": "#/components/schemas/ApisViewsV1TimeSelection" }, "filters": { "$ref": "#/components/schemas/ApisViewsV1SelectedFilters" }, "folder_id": { "example": "3dc02998-0b50-4ea8-b68a-4779d716fa1f", "description": "View folder ID", "type": "string", "format": "uuid", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "tier": { "$ref": "#/components/schemas/ApisViewsV1ViewType" } }, "required": [ "id", "name", "time_selection" ] }, "ViewCollection": { "example": { "views": [ { "filters": { "filters": [ { "name": "applicationName", "selected_values": { "demo": true } }, { "name": "subsystemName", "selected_values": { "demo": true } }, { "name": "operationName", "selected_values": { "demo": true } }, { "name": "serviceName", "selected_values": { "demo": true } }, { "name": "severity", "selected_values": { "demo": true } } ] }, "id": 52, "name": "Logs view", "search_query": { "query": "logs" }, "time_selection": { "custom_selection": { "from_time": "2024-01-25T11:31:43.152Z", "to_time": "2024-01-25T11:37:13.238Z" } } } ] }, "description": "List of views", "type": "object", "properties": { "views": { "description": "List of views", "type": "array", "items": { "$ref": "#/components/schemas/View" }, "minItems": 0, "maxItems": 4096 } } } }, "securitySchemes": { "Auth": { "type": "http", "scheme": "bearer" } }, "links": { "AlertID": { "description": "Link AlertID to subsequent operations", "operationId": "get_alert", "parameters": { "id": "$response.body#/id" } }, "AlertDefinitionID": { "description": "Link AlertDefinitionID to subsequent operations", "operationId": "get_alert_def", "parameters": { "id": "$response.body#/id" } }, "RuleGroupID": { "description": "Link RuleGroupID to subsequent operations", "operationId": "get_rule_group", "parameters": { "id": "$response.body#/id" } }, "PolicyID": { "description": "Link PolicyID to subsequent operations", "operationId": "get_policy", "parameters": { "id": "$response.body#/id" } }, "OutgoingWebhookID": { "description": "Link OutgoingWebhookID to subsequent operations", "operationId": "get_outgoing_webhook", "parameters": { "id": "$response.body#/id" } }, "DashboardID": { "description": "Link DashboardID to subsequent operations", "operationId": "get_dashboard", "parameters": { "id": "$response.body#/id" } }, "FolderID": { "description": "Link FolderID to subsequent operations", "operationId": "replace_dashboard_folder", "parameters": { "id": "$response.body#/id" } }, "Events2MetricsID": { "description": "Link Events2MetricsID to subsequent operations", "operationId": "get_e2m", "parameters": { "id": "$response.body#/id" } }, "ViewID": { "description": "Link ViewID to subsequent operations", "operationId": "get_view", "parameters": { "id": "$response.body#/id" } }, "ViewFolderID": { "description": "Link ViewFolderID to subsequent operations", "operationId": "get_view_folder", "parameters": { "id": "$response.body#/id" } }, "EnrichmentsID": { "description": "Link EnrichmentsID to subsequent operations", "operationId": "add_enrichments", "parameters": { "id": "$response.body#/id" } }, "DataAccessRulesID": { "description": "Link DataAccessRulesID to subsequent operations", "operationId": "create_data_access_rule", "parameters": { "id": "$response.body#/id" } }, "StreamID": { "description": "Link StreamID to subsequent operations", "operationId": "get_event_stream_targets", "parameters": { "id": "$response.body#/id" } } } }, "security": [ { "Auth": [] } ], "tags": [ { "name": "Alert definitions", "description": "Create and manage alert definitions" }, { "name": "Alerts", "description": "Create and manage alerts." }, { "name": "Background Query (Asynchronous Archive Query)", "description": "Submit a background query and fetch your archive logs." }, { "name": "Dashboards", "description": "Create and manage your dashboards." }, { "name": "Data access rules", "description": "Create and manage Data Access Rules." }, { "name": "Data usage", "description": "Data usage service." }, { "name": "Enrichments", "description": "Create and manage enrichments." }, { "name": "Events to metrics", "description": "Create and manage your events to metrics definitions." }, { "name": "Extensions", "description": "Manage extensions and extension deployments" }, { "name": "Folders for dashboards", "description": "Create and manage your dashboard folders." }, { "name": "Folders for views", "description": "Create and manage view folders." }, { "name": "Log data retention tags", "description": "Get and update log data retention tags" }, { "name": "Outbound Integrations", "description": "Create and manage your outbound integrations so that you can receive alerts." }, { "name": "Policies", "description": "Create and manage TCO policies." }, { "name": "Query", "description": "Query and process your logs." }, { "name": "Rules", "description": "Create and manage parsing rules." }, { "name": "Streams", "description": "Create and manage your Event Streams Integrations." }, { "name": "Views", "description": "Create and manage views" } ] }