{ "components": { "parameters": { "AccessKeyIdPath": { "description": "The access key id.", "in": "path", "name": "accessKeyId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "Filter": { "description": "The filter by field separated by a colon for the filter value", "in": "query", "name": "filter", "required": false, "schema": { "default": "", "example": "name:filter", "maxLength": 8192, "type": "string" } }, "GroupMappingIdPath": { "description": "The group mapping ID.", "in": "path", "name": "groupMappingId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "InhibitionRulePath": { "description": "The inhibition rule ID.", "in": "path", "name": "inhibitionRuleId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "IpFilterIdPath": { "description": "IP Filter ID.", "in": "path", "name": "ipFilterId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "Limit": { "description": "The number of items to return", "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "example": 25, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "MultiFilter": { "description": "Filters to apply in the form of `key:value`.\\\nMultiple filters can be applied by repeating the `filter` parameter:\\\n`&filter=key1:value1&filter=key2:value2`\n", "in": "query", "name": "filter", "required": false, "schema": { "default": [], "items": { "default": "", "example": "first_name:john", "maxLength": 512, "type": "string" }, "maxItems": 4, "type": "array" }, "style": "form" }, "Offset": { "description": "The offset number of items to start with", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "example": 30, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "OrderBy": { "description": "The order by field separated by a colon for the direction", "in": "query", "name": "orderby", "required": false, "schema": { "default": "", "example": "name:asc", "maxLength": 256, "type": "string" } }, "PermissionsFilter": { "description": "Filter by products when getting permissions for custom roles.\\\nAvaliable products are: SDS, SDC.\\\nYou can specify a single product or a list of products separated by commas.\\\nProduct names are case-sensitive.\\\nIf not specified, all permissions are returned.\n", "in": "query", "name": "filter", "required": false, "schema": { "default": "", "example": "products:SDS", "maxLength": 8192, "type": "string" } }, "PricingIdPath": { "description": "The pricing ID.", "in": "path", "name": "pricingId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "RoleIdPath": { "description": "The role id.", "in": "path", "name": "roleId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "ServiceAccountIdPath": { "description": "The service account ID.", "in": "path", "name": "serviceAccountId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "SsoSettingsIdPath": { "description": "SSO settings ID.", "in": "path", "name": "ssoSettingsId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "TeamIdPath": { "description": "The team ID.", "in": "path", "name": "teamId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } }, "UserIdPath": { "description": "The user ID.", "in": "path", "name": "userId", "required": true, "schema": { "$ref": "#/components/schemas/UnlimitedLong" } } }, "responses": { "BadRequest": { "content": { "application/json": { "example": { "details": [], "message": "Bad request", "type": "bad_request" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Operation failed due to invalid payload.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "Conflict": { "content": { "application/json": { "example": { "details": [], "message": "Conflict", "type": "conflict" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "Forbidden": { "content": { "application/json": { "example": { "details": [], "message": "Forbidden", "type": "forbidden" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not enough privileges to complete the action.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "InternalServerError": { "content": { "application/json": { "example": { "details": [], "message": "Internal server error", "type": "internal_server_error" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal server error." }, "NotFound": { "content": { "application/json": { "example": { "details": [], "message": "Resource not found", "type": "resource_not_found" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "TooManyRequests": { "content": { "application/json": { "example": { "details": [], "message": "Too many requests", "type": "too_many_requests" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too many requests.", "headers": { "Retry-After": { "description": "Retry after X seconds.", "required": false, "schema": { "format": "int32", "maximum": 14400, "minimum": 1, "type": "integer" } }, "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "Unauthorized": { "content": { "application/json": { "example": { "details": [], "message": "Unauthorized", "type": "unauthorized" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Access denied.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "UnprocessableEntity": { "content": { "application/json": { "example": { "details": [], "message": "Unprocessable content", "type": "unprocessable_content" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Server was unable to process the request.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "UnsupportedMediaType": { "content": { "application/json": { "example": { "details": [], "message": "Unsupported media type", "type": "unsupported_media_type" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Server cannot accept content of type specified in Content-Type header.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } } }, "schemas": { "ADVANCED_MANUAL": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "ADVANCED_MANUAL", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/AdvancedManualAlertConfigV2DTO" } } } ] }, "ALERT": { "required": [ "alertId", "alertResolution", "alertState", "alertType", "name", "notificationId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CombinedEvent" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The event id", "readOnly": true }, "version": { "type": "integer", "description": "Event version. Do not specify it when creating new events For an event update to be successful, the value shall match the current value of the existing event.", "format": "int64" }, "name": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Event name. Will be indexed to enable event search", "example": "Jenkins - start wordpress deploy" }, "description": { "type": "string", "description": "Optional event description. If present, will be indexed to enable event search", "example": "deploy" }, "severity": { "type": "string", "description": "Event Severity. Defaults to MEDIUM if not specified", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] }, "scope": { "maxLength": 10000, "minLength": 0, "type": "string", "description": "The event scope. Labels defined in the event scope will be indexed unless \"scopeLabels\" field is explicitly defined", "example": "host.hostName = \"ip-10-1-1-1\" and build = \"89\"" }, "timestamp": { "type": "integer", "description": "The event time in milliseconds. If not specified, current server time will be used", "format": "int64", "readOnly": true }, "createdOn": { "type": "integer", "description": "The time in millisecond when the event was created in the system", "format": "int64", "readOnly": true }, "scopeLabels": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {}, "items": { "type": "string", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": "{}" } }, "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {} }, "alertId": { "type": "integer", "description": "Alert id", "format": "int64" }, "notificationId": { "type": "integer", "description": "Alert notification id", "format": "int64" }, "notificationTitle": { "type": "string", "description": "Alert notification title" }, "timespan": { "type": "integer", "description": "Duration in milliseconds of the alert before it triggers. This field is deprecated in favour of appropriate range, duration or observationWindow fields", "format": "int64" }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation of the alert. Measured in seconds", "format": "int64" }, "duration": { "type": "integer", "description": "A time interval that defines for how long an alert condition should be met before an alert occurrence is created. Measured in seconds", "format": "int64" }, "observationWindow": { "type": "integer", "description": "Observation Window for the alert. Measured in seconds", "format": "int64" }, "endTimestamp": { "type": "integer", "description": "The time in milliseconds when the alert went into the resolved state", "format": "int64" }, "alertType": { "type": "string", "enum": [ "BASELINE", "HOST_COMPARISON", "MANUAL", "EVENT", "POLICYEVENT", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "alertState": { "type": "string", "enum": [ "TRIGGERED", "RESOLVED" ] }, "alertResolution": { "type": "string", "description": "Acknowledgement status of the alert", "enum": [ "ACKNOWLEDGED", "UNACKNOWLEDGED" ] }, "alertScope": { "type": "string" }, "alertCondition": { "type": "string", "description": "The alert condition that caused the alert triggering. When the alert is PROMETHEUS this fields contains the PromQL query to execute" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" } }, "endEntities": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" } }, "notificationChannels": { "type": "array", "description": "Notification channels associated to the alert when the event was generated", "items": { "$ref": "#/components/schemas/NotificationChannel" } }, "silencedByRules": { "type": "boolean", "description": "Indicates whether this event was silenced because of a silencing rule" }, "silencingRules": { "type": "array", "description": "Lists the silencing rules that matched this event", "items": { "$ref": "#/components/schemas/SilencingRule" } }, "noData": { "type": "boolean", "description": "Indicates whether this alert event was produced because of a no data value during alert check" }, "alertThreshold": { "type": "string", "description": "The threshold for which this alert event was generated", "enum": [ "MAIN", "WARNING" ] }, "alertConditionLabel": { "type": "string", "description": "Label associated to the alert condition that triggered" }, "manuallyResolved": { "type": "boolean", "description": "Indicates whether this alert event was manually resolved" }, "translatedToPromQLCondition": { "type": "string", "description": "The promQL query generated from the alert condition" }, "alertDeactivationReason": { "type": "string", "description": "The reason why the associated entity was deactivated", "enum": [ "MAX_SEGMENTS_LIMIT_REACHED", "MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED", "UNREPORTED_ALERT_NOTIFICATION" ] }, "alertGroupOutliersAlgorithm": { "type": "string", "description": "The algorithm used for group outlier alert check", "example": "MAD", "enum": [ "MAD", "MAD_SCALED", "DBSCAN", "DBSCAN_SCALED" ] }, "alertMadThreshold": { "type": "number", "description": "The outlier persistence percentage to apply to the MAD algorithm for group outlier detection", "format": "float", "example": 15 }, "alertMadTolerance": { "type": "number", "description": "The tolerance to apply to the MAD algorithm for group outlier detection", "format": "float", "example": 3 }, "alertDbscanTolerance": { "type": "number", "description": "The tolerance for the DBSCAN algorithm used for group outlier detection", "format": "float", "example": 3 }, "inhibitedBy": { "$ref": "#/components/schemas/InhibitedBy" }, "alertLabels": { "type": "object", "additionalProperties": { "type": "string", "description": "Labels associated to the alert definition of this alert event" }, "description": "Labels associated to the alert definition of this alert event" }, "type": { "type": "string", "description": "Event type. Only allowed value for creation/update of events is CUSTOM", "example": "CUSTOM", "enum": [ "ALERT", "CUSTOM", "POLICY", "SCANNING", "SYSDIG" ] } } } ] }, "ANOMALY_DETECTION": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "ANOMALY_DETECTION", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/AnomalyDetectionAlertConfigV2DTO" } } } ] }, "AccessKeyRequestDto": { "type": "object", "properties": { "limit": { "minimum": 0, "type": "integer", "description": "Maximum number of agents that can be connected with the access key", "format": "int32", "example": 100 }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "Access key metadata" }, "description": "Access key metadata" }, "reservation": { "minimum": 0, "type": "integer", "description": "Number of agents that are guaranteed to be available for the access key", "format": "int32", "example": 5 }, "teamId": { "minimum": 0, "type": "integer", "description": "ID of team that owns the access key", "format": "int32", "example": 13 } }, "description": "Customer access key request" }, "AccessKeyRequestWrapper": { "required": [ "customerAccessKey" ], "type": "object", "properties": { "customerAccessKey": { "$ref": "#/components/schemas/AccessKeyRequestDto" } } }, "AdvancedManualAlertConfigV2DTO": { "required": [ "segmentBy" ], "type": "object", "properties": { "condition": { "type": "string", "description": "The advanced condition string", "example": "avg(timeAvg(sysdig_container_cpu_used_percent)) > 50 and avg(timeAvg(sysdig_container_cpu_used_percent)) < 90" }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "query": { "type": "string", "description": "The translation of the alert condition to PromQL, if supported", "readOnly": true }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } } }, "description": "Advanced Manual Alert Config V2" }, "Agentcaptureconfiguration": { "required": [ "duration", "name" ], "type": "object", "properties": { "bucketName": { "type": "string", "description": "Name of S3 bucket" }, "duration": { "maximum": 86400, "minimum": 1, "type": "integer", "description": "Capture duration in seconds", "format": "int64" }, "filters": { "type": "string" }, "folder": { "type": "string" }, "name": { "type": "string" }, "storageId": { "type": "integer", "format": "int32" } }, "description": "Agentcaptureconfiguration" }, "Alert": { "required": [ "type" ], "type": "object", "properties": { "condition": { "type": "string", "description": "String expressing the main condition of the alert. When the alert is PROMETHEUS this fields contains the PromQL query to execute", "example": "avg(min(sysdig_container_cpu_used_percent)) > 50" }, "createdOn": { "type": "integer", "description": "Creation time in milliseconds", "format": "int64" }, "criteria": { "$ref": "#/components/schemas/AlertEventsCriteria" }, "customNotification": { "$ref": "#/components/schemas/CustomNotification" }, "dbscanTolerance": { "type": "number", "description": "The tolerance for the DBSCAN algorithm used for group outlier detection", "format": "float", "example": 3 }, "deactivationReason": { "type": "string", "description": "If the alert was deactivated by the system this represents the reason why it happened", "readOnly": true, "enum": [ "MAX_SEGMENTS_LIMIT_REACHED", "MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED", "MAX_SEGMENTS_LIMIT_REACHED", "MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED" ] }, "description": { "type": "string", "description": "Brief description of the alert" }, "duration": { "type": "integer", "description": "A time interval that defines for how long an Alert's condition should be met before an Alert Occurrence is created. Measured in seconds", "format": "int64", "example": 60 }, "enabled": { "type": "boolean", "description": "Enable/disable status of the alert" }, "filter": { "type": "string", "description": "Scope for the alert", "example": "kubernetes.cluster.name = 'foo'" }, "groupName": { "type": "string", "description": "Name of the group the alert is part of. If not set, `Default` is used." }, "groupOutliersAlgorithm": { "type": "string", "description": "The algorithm used for group outlier alert check", "example": "MAD", "enum": [ "MAD", "DBSCAN", "MAD_SCALED", "DBSCAN_SCALED" ] }, "id": { "type": "integer", "description": "Unique ID. Must be null when creating a new one.", "format": "int64" }, "keepFiringForSec": { "type": "integer", "description": "The minimum amount of time in seconds that an alert occurrence should remain triggering, after the promQL expression does not return any results", "format": "int64" }, "madThreshold": { "type": "number", "description": "The outlier persistence percentage to apply to the MAD algorithm for group outlier detection", "format": "float", "example": 15 }, "madTolerance": { "type": "number", "description": "The tolerance to apply to the MAD algorithm for group outlier detection", "format": "float", "example": 3 }, "mainConditionLabel": { "type": "string", "description": "String expressing the main condition label of the alert", "example": "Critical" }, "modifiedOn": { "type": "integer", "description": "Last modification time in milliseconds", "format": "int64" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Name of the alert" }, "noDataBehaviour": { "type": "string", "description": "How the system should behaves when no data is returned for the selected metric. Defaults to DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER" ] }, "notificationChannelIds": { "uniqueItems": true, "type": "array", "description": "List of notification channels IDs assigned to this alert", "items": { "type": "integer", "description": "List of notification channels IDs assigned to this alert", "format": "int64" } }, "percentageOfChangeLongerRangeSec": { "type": "integer", "description": "The Percentage of Change longer range", "format": "int64", "example": 600 }, "percentageOfChangeShorterRangeSec": { "type": "integer", "description": "The Percentage of Change shorter range", "format": "int64", "example": 60 }, "reNotify": { "type": "boolean", "description": "True if the alert should re-notify when triggered" }, "reNotifyMinutes": { "minimum": 1, "type": "integer", "description": "When reNotify is true this represents the number of minutes after the alert re-notify if triggered", "format": "int32", "example": 1 }, "segmentBy": { "type": "array", "description": "Alert segmentation", "items": { "type": "string", "description": "Alert segmentation" } }, "segmentCondition": { "$ref": "#/components/schemas/AlertGroupCondition" }, "severity": { "maximum": 7, "minimum": 0, "type": "integer", "description": "Alert severity expressed as a number. 0 is highest, 7 lower. 0,1 are mapped in UI as HIGH, 2,3 are mapped as MEDIUM, 4,5 LOW and 6,7 NONE (INFO). See also SeverityLabel.", "format": "int32", "example": 1, "enum": [ null ] }, "severityLabel": { "type": "string", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] }, "sysdigCapture": { "$ref": "#/components/schemas/Agentcaptureconfiguration" }, "timespan": { "type": "integer", "description": "Range of a set of data points considered for the time aggregation", "format": "int64" }, "type": { "type": "string", "description": "Type of the alert", "enum": [ "BASELINE", "HOST_COMPARISON", "MANUAL", "EVENT", "POLICYEVENT", "PROMETHEUS", "RECORDING_RULE", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS", "MANUAL", "PROMETHEUS", "EVENT", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE" ] }, "unreportedAlertNotificationsRetentionSec": { "maximum": 2592000, "minimum": 1, "type": "integer", "description": "The retention time for which an alert notification should be kept as active when an associated metric is not reported anymore. Expressed in seconds", "format": "int32", "example": 259200, "enum": [ null ] }, "valid": { "type": "boolean" }, "version": { "type": "integer", "description": "Object version. Must be null when creating a new one.", "format": "int64" }, "warningCondition": { "type": "string", "description": "String expressing the warning condition of the alert. The aggregations and metric must be equal to the condition, only operator and threshold can change", "example": "avg(min(sysdig_container_cpu_used_percent)) > 30" }, "warningConditionLabel": { "type": "string", "description": "String expressing the warning condition label of the alert", "example": "Warning" } }, "description": "Alert" }, "AlertBulkRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "AlertBulkRequestWrapper": { "required": [ "alerts" ], "type": "object", "properties": { "alerts": { "$ref": "#/components/schemas/AlertBulkRequest" } }, "description": "Bulk alert request object" }, "AlertCaptureConfigV2": { "required": [ "durationSec", "fileName" ], "type": "object", "properties": { "durationSec": { "maximum": 86400, "minimum": 1, "type": "integer", "description": "Capture duration in seconds", "format": "int64", "example": 1800 }, "enabled": { "type": "boolean", "description": "Capture enablement status", "example": false }, "fileName": { "type": "string", "description": "Capture file name" }, "filter": { "type": "string", "description": "Capture filter" }, "storage": { "type": "string", "description": "Capture storage", "example": "S3" } }, "description": "Alert V2 Capture Config" }, "AlertConfigV2DTO": { "type": "object" }, "AlertEventsCriteria": { "type": "object", "properties": { "query": { "type": "string" }, "scope": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } } }, "AlertGeneratedQueryWrapper": { "type": "object", "properties": { "query": { "type": "string" } } }, "AlertGroup": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AlertGroupCondition": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of grouping. Default to ANY. Accepted values are: ALL (group all notifications), ANY (Don't group), COUNT gGroup after a threshold), PERCENT (group a percentage of notification)", "enum": [ "ALL", "ANY", "COUNT", "PERCENT" ] }, "value": { "type": "number", "description": "Threshold used when type is COUNT or PERCENTAGE", "format": "double" } }, "description": "Configuration for grouping notification feature" }, "AlertLabelDescriptorV2DTO": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The metric ID" }, "publicId": { "type": "string", "description": "The prometheus public ID" } }, "description": "Alert Label Descriptor V2", "example": [] }, "AlertLinkDTO": { "type": "object", "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "dashboard", "dashboardTemplate", "runbook" ] } } }, "AlertLinkV2": { "required": [ "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "The url this link refers to. Required when type is runbook" }, "id": { "type": "string", "description": "The id of the entity this link refers to. Required when type is dashboard or dashboard template", "example": "45" }, "name": { "type": "string", "description": "The name associated with this link, if any", "readOnly": true }, "type": { "type": "string", "description": "The kind of entity this link refers to", "example": "dashboard", "enum": [ "dashboard", "dashboardTemplate", "runbook" ] } }, "description": "Links to other entities (e.g. dashboards, runbooks)" }, "AlertListDTO": { "type": "object", "properties": { "alertSummary": { "type": "string" }, "alertTemplateName": { "type": "string" }, "condition": { "type": "string" }, "createdOn": { "type": "integer", "format": "int64" }, "criteria": { "$ref": "#/components/schemas/AlertEventsCriteria" }, "customNotification": { "$ref": "#/components/schemas/CustomNotification" }, "dbscanTolerance": { "type": "number", "format": "float" }, "deactivationReason": { "type": "string", "enum": [ "MAX_SEGMENTS_LIMIT_REACHED", "MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED" ] }, "defaultSettings": { "type": "array", "items": { "$ref": "#/components/schemas/AlertNotificationChannelSettings" } }, "description": { "type": "string" }, "duration": { "type": "integer", "format": "int64" }, "enabled": { "type": "boolean" }, "eventsCount": { "type": "array", "items": { "$ref": "#/components/schemas/EventsCountBySample" } }, "filter": { "type": "string" }, "groupName": { "type": "string" }, "groupOutliersAlgorithm": { "type": "string", "enum": [ "MAD", "DBSCAN", "MAD_SCALED", "DBSCAN_SCALED" ] }, "groupOutliersRangeSec": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "lastTriggeredNotification": { "$ref": "#/components/schemas/NotificationInfoDTO" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/AlertLinkDTO" } }, "madThreshold": { "type": "number", "format": "float" }, "madTolerance": { "type": "number", "format": "float" }, "modifiedOn": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "notificationChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationChannelDTO" } }, "notificationCount": { "type": "integer", "format": "int64" }, "observationWindow": { "type": "integer", "format": "int64" }, "overrideSettings": { "type": "array", "items": { "$ref": "#/components/schemas/AlertNotificationChannelSettings" } }, "range": { "type": "integer", "format": "int64" }, "reNotify": { "type": "boolean" }, "resetCriteria": { "$ref": "#/components/schemas/AlertEventsCriteria" }, "segmentBy": { "type": "array", "items": { "type": "string" } }, "severity": { "type": "string" }, "sysdigCapture": { "$ref": "#/components/schemas/Agentcaptureconfiguration" }, "teamId": { "type": "integer", "format": "int32" }, "timespan": { "type": "integer", "format": "int64" }, "translatedToPromQLCondition": { "type": "string" }, "triggering": { "type": "boolean" }, "type": { "type": "string", "enum": [ "BASELINE", "HOST_COMPARISON", "MANUAL", "EVENT", "POLICYEVENT", "PROMETHEUS", "RECORDING_RULE", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "valid": { "type": "boolean" }, "version": { "type": "integer", "format": "int64" }, "warningCondition": { "type": "string" }, "warningSummary": { "type": "string" } } }, "AlertListWrapper": { "type": "object", "properties": { "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/AlertListDTO" } }, "alertsCount": { "type": "integer", "description": "Total number of alerts belonging to the team", "format": "int64" }, "summary": { "$ref": "#/components/schemas/AlertSummary" } } }, "AlertMetricDescriptorV2DTO": { "type": "object", "properties": { "groupAggregations": { "uniqueItems": true, "type": "array", "description": "Set of group aggregations", "items": { "type": "string", "description": "Set of group aggregations", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } }, "id": { "type": "string", "description": "The metric ID" }, "metricType": { "type": "string", "description": "The metric type" }, "publicId": { "type": "string", "description": "The prometheus public ID" }, "scale": { "type": "number", "description": "The scale", "format": "double" }, "timeAggregations": { "uniqueItems": true, "type": "array", "description": "Set of time aggregations", "items": { "type": "string", "description": "Set of time aggregations", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } }, "type": { "type": "string", "description": "The type" } }, "description": "Alert Metric Descriptor V2", "readOnly": true }, "AlertNotificationChannelSettings": { "type": "object", "properties": { "notificationChannelId": { "type": "integer", "format": "int64" }, "options": { "$ref": "#/components/schemas/NotificationChannelOptions" }, "type": { "type": "string" } } }, "AlertScopeV2DTO": { "type": "object", "properties": { "expressions": { "type": "array", "description": "Scope specified as a list of scope expressions.", "items": { "$ref": "#/components/schemas/ScopeExpressionV2DTO" } }, "text": { "type": "string", "description": "Scope expressed as a text string. On writes, will only take effect if the \"expressions\" field is not specified" } }, "description": "Alert Scope V2" }, "AlertSummary": { "type": "object", "properties": { "all": { "type": "integer", "format": "int32" }, "deactivated": { "type": "integer", "format": "int32" }, "triggered": { "type": "integer", "format": "int32" }, "unreportedDescriptors": { "type": "integer", "format": "int32" } } }, "AlertTag": { "type": "object", "properties": { "createdOn": { "type": "integer", "description": "Creation time in milliseconds", "format": "int64" }, "id": { "type": "integer", "description": "Unique ID. Must be null when creating a new one.", "format": "int64" }, "modifiedOn": { "type": "integer", "description": "Last modification time in milliseconds", "format": "int64" }, "name": { "type": "string" }, "version": { "type": "integer", "description": "Object version. Must be null when creating a new one.", "format": "int64" } } }, "AlertTagWrapper": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/AlertTag" } }, "description": "Alert tag object" }, "AlertV2": { "type": "object", "properties": { "captureConfig": { "$ref": "#/components/schemas/AlertCaptureConfigV2" }, "config": { "$ref": "#/components/schemas/AlertConfigV2DTO" }, "createdOn": { "type": "integer", "description": "Alert creation instant in milliseconds", "format": "int64", "example": 1638531034107 }, "customNotificationTemplate": { "$ref": "#/components/schemas/CustomNotificationTemplateV2DTO" }, "deactivationReason": { "type": "string", "description": "If the alert was deactivated by the system this represents the reason why it happened", "readOnly": true, "enum": [ "MAX_SEGMENTS_LIMIT_REACHED", "MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED", "MAX_SEGMENTS_LIMIT_REACHED", " MAX_ACTIVE_NOTIFICATIONS_LIMIT_REACHED" ] }, "description": { "type": "string", "description": "Alert description", "example": "Sample alert description" }, "durationSec": { "type": "integer", "description": "Alert range/duration in seconds. This field will be mapped to duration in case the alert type is PROMETHEUS, to observationWindow in case of GROUP_OUTLIERS, to range otherwise. This field is deprecated in favour of appropriate config.range, config.duration or config.observationWindow fields", "format": "int64", "example": 180, "deprecated": true }, "enabled": { "type": "boolean", "description": "Enabled flag", "example": true }, "group": { "type": "string", "description": "Alert group", "example": "Default" }, "id": { "type": "integer", "description": "Alert ID", "format": "int64", "readOnly": true, "example": 10 }, "labels": { "type": "object", "additionalProperties": { "type": "string", "description": "map of key/values to be used to tag the alert" }, "description": "map of key/values to be used to tag the alert" }, "links": { "type": "array", "description": "List of links for this alert", "items": { "$ref": "#/components/schemas/AlertLinkV2" } }, "modifiedOn": { "type": "integer", "description": "Alert modification instant in milliseconds", "format": "int64", "example": 1638531060020 }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Alert name", "example": "Sample alert" }, "notificationChannelConfigList": { "type": "array", "description": "List of notification channels configurations for this alert", "items": { "$ref": "#/components/schemas/NotificationChannelConfigV2DTO" } }, "severity": { "type": "string", "description": "Alert severity", "example": "high", "enum": [ "high", "medium", "low", "none" ] }, "teamId": { "type": "integer", "description": "Team ID", "format": "int32", "readOnly": true, "example": 14 }, "type": { "type": "string", "description": "Alert type", "example": "MANUAL_ALERT", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "unreportedAlertNotificationsRetentionSec": { "maximum": 2592000, "minimum": 1, "type": "integer", "description": "The retention time for which an alert notification should be kept as active when an associated metric is not reported anymore. Expressed in seconds", "format": "int32", "example": 259200, "enum": [ null ] }, "version": { "type": "integer", "description": "Alert version", "format": "int64", "readOnly": true, "example": 3 } }, "description": "Alert V2", "discriminator": { "propertyName": "type", "mapping": { "ADVANCED_MANUAL": "#/components/schemas/ADVANCED_MANUAL", "ANOMALY_DETECTION": "#/components/schemas/ANOMALY_DETECTION", "DOWNTIME": "#/components/schemas/DOWNTIME", "EVENT": "#/components/schemas/EVENT", "LEGACY_GROUP_OUTLIER": "#/components/schemas/LEGACY_GROUP_OUTLIER", "MANUAL": "#/components/schemas/MANUAL", "PROMETHEUS": "#/components/schemas/PROMETHEUS", "FORM_BASED_PROMETHEUS": "#/components/schemas/FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE": "#/components/schemas/PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS": "#/components/schemas/GROUP_OUTLIERS" } } }, "AlertV2Wrapper": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" } }, "description": "Alert V2 Wrapper", "discriminator": { "propertyName": "exampleType" }, "oneOf": [ { "$ref": "#/components/schemas/DowntimeAlertExample" }, { "$ref": "#/components/schemas/ManualAlertExample" }, { "$ref": "#/components/schemas/EventAlertExample" }, { "$ref": "#/components/schemas/PrometheusAlertExample" }, { "$ref": "#/components/schemas/FormBasedPrometheusAlertExample" }, { "$ref": "#/components/schemas/PercentageOfChangeAlertExample" }, { "$ref": "#/components/schemas/GroupOutliersAlertExample" } ] }, "AlertWrapper": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/Alert" } }, "description": "Alert definition" }, "AnomalyDetectionAlertConfigV2DTO": { "required": [ "metricIds", "segmentBy" ], "type": "object", "properties": { "metricIds": { "type": "array", "description": "List of metric ids", "items": { "type": "string", "description": "List of metric ids" } }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } } }, "description": "Anomaly Detection Alert Config V2" }, "AxisDomain": { "type": "object", "properties": { "from": { "type": "number" }, "to": { "type": "number" } } }, "BulkActionRequest": { "required": [ "dashboardIds" ], "type": "object", "properties": { "dashboardIds": { "type": "array", "description": "The list of dashboard ids to apply the bulk action. It may contain custom dashboard ids and/or libraries ids", "items": { "type": "string", "description": "The list of dashboard ids to apply the bulk action. It may contain custom dashboard ids and/or libraries ids" } }, "simulate": { "type": "boolean", "description": "Simulates the bulk action without applying it. Used to verify possible issues and permissions to the input set" } } }, "BulkActionResponse": { "required": [ "errorIds", "successIds" ], "type": "object", "properties": { "errorIds": { "type": "array", "description": "The list of dashboard ids where the bulk action was not applied due to some validation/error", "items": { "$ref": "#/components/schemas/BulkActionResponseError" } }, "successIds": { "type": "array", "description": "The list of dashboard ids where the bulk action was successfully applied", "items": { "type": "string", "description": "The list of dashboard ids where the bulk action was successfully applied" } } } }, "BulkActionResponseError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "cannotDeleteDashboardLibrary", "noPermissionToDeleteCustomDashboard", "dashboardNotFound" ] }, "dashboardId": { "type": "string" }, "message": { "type": "string" } }, "description": "The list of dashboard ids where the bulk action was not applied due to some validation/error" }, "CUSTOM": { "required": [ "name" ], "type": "object", "properties": { "createdOn": { "type": "integer", "description": "The time in millisecond when the event was created in the system", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Optional event description. If present, will be indexed to enable event search", "example": "deploy" }, "id": { "type": "string", "description": "The event id", "readOnly": true }, "name": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Event name. Will be indexed to enable event search", "example": "Jenkins - start wordpress deploy" }, "scope": { "maxLength": 10000, "minLength": 0, "type": "string", "description": "The event scope. Labels defined in the event scope will be indexed unless \"scopeLabels\" field is explicitly defined", "example": "host.hostName = \"ip-10-1-1-1\" and build = \"89\"" }, "scopeLabels": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {}, "items": { "type": "string", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": "{}" } }, "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {} }, "severity": { "type": "string", "description": "Event Severity. Defaults to MEDIUM if not specified", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] }, "source": { "type": "string", "description": "Event source. Will be set to the default value of \"api\" unless it is explicitly specified or a tag with key \"source\" is specified; in the latter case it will take the tag value. If both this field and the \"source\" tag are specified, their value must be the same", "example": "jenkins" }, "tags": { "type": "object", "additionalProperties": { "type": "object", "description": "Custom event tags, i.e. key-value pairs. A default tag with key \"source\" and value \"api\" will be added by the server unless a tag with that key is explicitly specified or the source field is specified; in the latter case a \"source\" tag with the value of the source field will be added.If both the \"source\" tag and the \"source\" field are specified, their value must be the same.", "example": { "source": "jenkins" } }, "description": "Custom event tags, i.e. key-value pairs. A default tag with key \"source\" and value \"api\" will be added by the server unless a tag with that key is explicitly specified or the source field is specified; in the latter case a \"source\" tag with the value of the source field will be added.If both the \"source\" tag and the \"source\" field are specified, their value must be the same.", "example": { "source": "jenkins" } }, "timestamp": { "type": "integer", "description": "The event time in milliseconds. If not specified, current server time will be used", "format": "int64", "readOnly": true }, "type": { "type": "string", "description": "Event type. Only allowed value for creation/update of events is CUSTOM", "example": "CUSTOM", "enum": [ "ALERT", "CUSTOM", "POLICY", "SCANNING", "SYSDIG" ] }, "version": { "type": "integer", "description": "Event version. Do not specify it when creating new events For an event update to be successful, the value shall match the current value of the existing event.", "format": "int64" } } }, "ColorCoding": { "type": "object", "properties": { "active": { "type": "boolean" }, "thresholds": { "$ref": "#/components/schemas/Threshold" } } }, "CombinedEvent": { "required": [ "name" ], "type": "object", "description": "Combined Event V2", "discriminator": { "propertyName": "type" }, "allOf": [ { "$ref": "#/components/schemas/CUSTOM" }, { "$ref": "#/components/schemas/ALERT" }, { "$ref": "#/components/schemas/SYSDIG" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The event id", "readOnly": true }, "version": { "type": "integer", "description": "Event version. Do not specify it when creating new events For an event update to be successful, the value shall match the current value of the existing event.", "format": "int64" }, "name": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Event name. Will be indexed to enable event search", "example": "Jenkins - start wordpress deploy" }, "description": { "type": "string", "description": "Optional event description. If present, will be indexed to enable event search", "example": "deploy" }, "severity": { "type": "string", "description": "Event Severity. Defaults to MEDIUM if not specified", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] }, "scope": { "maxLength": 10000, "minLength": 0, "type": "string", "description": "The event scope. Labels defined in the event scope will be indexed unless \"scopeLabels\" field is explicitly defined", "example": "host.hostName = \"ip-10-1-1-1\" and build = \"89\"" }, "timestamp": { "type": "integer", "description": "The event time in milliseconds. If not specified, current server time will be used", "format": "int64", "readOnly": true }, "createdOn": { "type": "integer", "description": "The time in millisecond when the event was created in the system", "format": "int64", "readOnly": true }, "scopeLabels": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {}, "items": { "type": "string", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": "{}" } }, "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {} }, "type": { "type": "string", "description": "Event type. Only allowed value for creation/update of events is CUSTOM", "example": "CUSTOM", "enum": [ "ALERT", "CUSTOM", "POLICY", "SCANNING", "SYSDIG" ] } } } ] }, "ComparableDataWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "metrics", "showAs" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DataWidget" }, { "type": "object", "properties": { "showAs": { "type": "string", "enum": [ "timeSeries", "timeSeriesArea", "top", "histogram", "segmentedHistogram", "table", "map", "summary", "text" ] }, "name": { "type": "string" }, "gridConfiguration": { "$ref": "#/components/schemas/GridConfiguration" }, "customDisplayOptions": { "$ref": "#/components/schemas/CustomDisplayOptions" }, "scope": { "type": "string" }, "overrideScope": { "type": "boolean" }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/WidgetMetric" } } } }, { "$ref": "#/components/schemas/DashboardWidget" } ], "oneOf": [ { "$ref": "#/components/schemas/SummaryComparableDataWidget" } ] }, "CopyTarget": { "required": [ "teams" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name to use for the copied alert" }, "teams": { "type": "array", "description": "List of team IDs to copy to", "items": { "type": "integer", "description": "List of team IDs to copy to", "format": "int32" } } }, "description": "Object describing how and where to copy the alert" }, "CustomDisplayOptions": { "required": [ "histogram", "valueLimit", "xAxis", "yAxisLeftDomain", "yAxisRightDomain", "yAxisScale" ], "type": "object", "properties": { "histogram": { "$ref": "#/components/schemas/Histogram" }, "valueLimit": { "$ref": "#/components/schemas/ValueLimit" }, "xAxis": { "$ref": "#/components/schemas/AxisDomain" }, "yAxisLeftDomain": { "$ref": "#/components/schemas/AxisDomain" }, "yAxisRightDomain": { "$ref": "#/components/schemas/AxisDomain" }, "yAxisScale": { "type": "string", "enum": [ "linear", "logarithmic2", "logarithmic10", "logarithmic32", "logarithmic1024", "exponential" ] } } }, "CustomNotification": { "type": "object", "properties": { "appendText": { "type": "string", "description": "Template to use for appended text (after auto generated body)" }, "prependText": { "type": "string", "description": "Template to use for prepended text (before auto generated body)" }, "titleTemplate": { "type": "string", "description": "Template to use for the title" } }, "description": "CustomNotification" }, "CustomNotificationTemplateV2DTO": { "type": "object", "properties": { "appendText": { "type": "string", "description": "Appended text after subject", "example": " appended text" }, "prependText": { "type": "string", "description": "Prepended text before subject", "example": "Prepended text " }, "subject": { "type": "string", "description": "Template subject", "example": "The subject {{__title__}}" } }, "description": "Custom Notification Template data" }, "CustomerAccessKeyDto": { "type": "object", "properties": { "accessKey": { "type": "string", "description": "Access key value", "example": "f983f7c5-d7c3-4901-b5e0-710811d34a15" }, "agentsConnected": { "type": "integer", "description": "Number of agents connected with the access key", "format": "int32" }, "dateCreated": { "type": "integer", "description": "Timestamp when access key was created", "format": "int64", "example": 1493816819000 }, "dateDisabled": { "type": "integer", "description": "Timestamp when access key was disabled", "format": "int64", "example": 1493816819000 }, "enabled": { "type": "boolean", "description": "Flag indicating if access key is disabled or enabled", "example": true }, "id": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "description": "Maximum number of agents that can be connected with the access key", "format": "int32", "example": 100 }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "description": "Access key metadata" }, "description": "Access key metadata" }, "reservation": { "type": "integer", "description": "Number of agents that are guaranteed to be available for the access key", "format": "int32", "example": 5 }, "teamId": { "type": "integer", "description": "ID of team that owns the access key", "format": "int32", "example": 13 }, "teamName": { "type": "string", "description": "Name of team that owns the access key", "example": "Dev team" } }, "description": "Customer access key" }, "CustomerAccessKeyDtoWrapper": { "type": "object", "properties": { "customerAccessKey": { "$ref": "#/components/schemas/CustomerAccessKeyDto" } } }, "CustomerAccessKeyTotalsDto": { "type": "object", "properties": { "accessKeysCount": { "type": "integer", "description": "Access keys count", "format": "int32" }, "connectedAgentsCount": { "type": "integer", "description": "Connected agents count", "format": "int32" }, "enabledAccessKeysCount": { "type": "integer", "description": "Enabled access keys count", "format": "int32" }, "limitsOverMaxAgents": { "type": "boolean", "description": "Flag indicating that defined agent limits are over max agents" }, "maxAgents": { "type": "integer", "description": "Maximum agents allowed by subscription", "format": "int32" }, "reservationsIgnored": { "type": "boolean", "description": "Flag indicating that defined agent reservations are over max agents, and that they will be ignored" }, "totalLimits": { "type": "integer", "description": "Sum of enabled access keys limits", "format": "int64" }, "totalReservations": { "type": "integer", "description": "Sum of all enabled access keys reservations", "format": "int64" } }, "description": "Customer access keys totals" }, "CustomerAccessKeysDtoWrapper": { "type": "object", "properties": { "customerAccessKeys": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAccessKeyDto" } }, "limit": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "DOWNTIME": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "DOWNTIME", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/DowntimeAlertConfigV2DTO" } } } ] }, "DashboardListWrapper": { "type": "object", "properties": { "mostPopularDashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardPopularityDTO" } }, "recentlyViewed": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardTrackingInfoDto" } } } }, "DashboardV3AdvancedGaugePanel": { "required": [ "advancedQueries", "id", "name", "numberThresholds", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedGauge" ] }, "advancedQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "Only a single query must be set for the gauge panel", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuerywithdataboundaries" } }, "numberThresholds": { "$ref": "#/components/schemas/DashboardV3GaugePanelThresholds" } } } ] }, "DashboardV3AdvancedNumberPanel": { "required": [ "id", "name", "numberThresholds", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedNumber" ] }, "advancedQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "A single PromQL advanced query must be set for the number panel. The PromQL query must return an instant vector result", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" } }, "numberThresholds": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholds" } } } ] }, "DashboardV3AdvancedPiechartPanel": { "required": [ "advancedQueries", "id", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedPiechart" ] }, "advancedQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "List of PromQL advanced queries for the piechart. The PromQL queries must return instant vector results", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" } } } } ] }, "DashboardV3AdvancedQuery": { "required": [ "compareTo", "displayInfo", "enabled", "format", "query" ], "type": "object", "description": "Advanced query making use of PromQL", "allOf": [ { "$ref": "#/components/schemas/PanelQuery" }, { "type": "object", "properties": { "query": { "type": "string", "description": "PromQL query", "example": "sum(metric_name) by (label_name)" }, "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" } } } ] }, "DashboardV3AdvancedQuerywithdataboundaries": { "required": [ "compareTo", "dataBoundaries", "displayInfo", "enabled", "format", "query" ], "type": "object", "properties": { "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" }, "dataBoundaries": { "$ref": "#/components/schemas/DashboardV3GaugePanelDataBoundaries" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "query": { "type": "string", "description": "PromQL query", "example": "sum(metric_name) by (label_name)" } }, "description": "Advanced query making use of PromQL with data boundaries" }, "DashboardV3AdvancedTablePanel": { "required": [ "advancedQueries", "id", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedTable" ] }, "advancedQueries": { "type": "array", "description": "List of PromQL advanced queries for the table.", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" } } } } ] }, "DashboardV3AdvancedTimechartPanel": { "required": [ "advancedQueries", "axesConfiguration", "id", "legendConfiguration", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedTimechart" ] }, "advancedQueries": { "type": "array", "description": "List of PromQL advanced queries for the timechart. The PromQL queries must return range vector results", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" } }, "legendConfiguration": { "$ref": "#/components/schemas/DashboardV3PanelLegendConfiguration" }, "axesConfiguration": { "$ref": "#/components/schemas/DashboardV3TimechartpanelAxisConfiguration" } } } ] }, "DashboardV3AdvancedToplistPanel": { "required": [ "advancedQueries", "id", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "advancedToplist" ] }, "advancedQueries": { "type": "array", "description": "List of PromQL advanced queries for the toplist. The PromQL queries must return instant vector results", "items": { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" } } } } ] }, "DashboardV3BasicFormGaugePanel": { "required": [ "basicQueries", "id", "name", "numberThresholds", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicGauge" ] }, "basicQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "Only a single basic query must be set for the gauge panel", "items": { "$ref": "#/components/schemas/DashboardV3BasicQuerywithdataboundaries" } }, "numberThresholds": { "$ref": "#/components/schemas/DashboardV3GaugePanelThresholds" } } } ] }, "DashboardV3BasicFormHistogramPanel": { "required": [ "basicQueries", "id", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicHistogram" ] }, "basicQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "Only a single Histogram basic query must be set for the Histogram panel", "items": { "$ref": "#/components/schemas/DashboardV3HistogramSegmentedBasicQuery" } } } } ] }, "DashboardV3BasicFormNumberPanel": { "required": [ "basicQueries", "id", "name", "numberThresholds", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicNumber" ] }, "basicQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "Only a single basic query must be set for the number panel", "items": { "$ref": "#/components/schemas/DashboardV3BasicQuery" } }, "numberThresholds": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholds" } } } ] }, "DashboardV3BasicFormPiechartPanel": { "required": [ "applyScopeToAll", "applySegmentationToAll", "basicQueries", "id", "name", "type" ], "type": "object", "description": "Basic Form Top List Panel", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicPiechart" ] }, "basicQueries": { "maxItems": 1, "minItems": 1, "type": "array", "description": "List of basic queries for the piechart panel", "items": { "$ref": "#/components/schemas/DashboardV3SegmentedBasicQuery" } }, "applyScopeToAll": { "type": "boolean", "description": "Whether the first query scope should be applied to all following queries defined in the panel" }, "applySegmentationToAll": { "type": "boolean", "description": "Whether the first query segmentation/grouping should be applied to all following queries defined in the panel" } } } ] }, "DashboardV3BasicFormTablePanel": { "required": [ "basicQueries", "id", "name", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicTable" ] }, "basicQueries": { "type": "array", "description": "List of basic queries for the table panel", "items": { "$ref": "#/components/schemas/DashboardV3SegmentedBasicQuery" } } } } ] }, "DashboardV3BasicFormTimechartPanel": { "required": [ "applyScopeToAll", "applySegmentationToAll", "axesConfiguration", "basicQueries", "id", "legendConfiguration", "name", "type" ], "type": "object", "description": "Basic Form Timechart Panel", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicTimechart" ] }, "basicQueries": { "type": "array", "description": "List of basic queries for the timechart panel", "items": { "$ref": "#/components/schemas/DashboardV3SegmentedBasicQuery" } }, "applyScopeToAll": { "type": "boolean", "description": "Whether the first query scope should be applied to all following queries defined in the panel" }, "applySegmentationToAll": { "type": "boolean", "description": "Whether the first query segmentation/grouping should be applied to all following queries defined in the panel" }, "legendConfiguration": { "$ref": "#/components/schemas/DashboardV3PanelLegendConfiguration" }, "axesConfiguration": { "$ref": "#/components/schemas/DashboardV3TimechartpanelAxisConfiguration" } } } ] }, "DashboardV3BasicFormTopListPanel": { "required": [ "applyScopeToAll", "applySegmentationToAll", "basicQueries", "id", "name", "type" ], "type": "object", "description": "Basic Form Top List Panel", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "basicToplist" ] }, "basicQueries": { "type": "array", "description": "List of basic queries for the toplist panel", "items": { "$ref": "#/components/schemas/DashboardV3SegmentedBasicQuery" } }, "applyScopeToAll": { "type": "boolean", "description": "Whether the first query scope should be applied to all following queries defined in the panel" }, "applySegmentationToAll": { "type": "boolean", "description": "Whether the first query segmentation/grouping should be applied to all following queries defined in the panel" } } } ] }, "DashboardV3BasicQuery": { "required": [ "compareTo", "displayInfo", "enabled", "format", "metrics", "scope" ], "type": "object", "description": "Basic form query without segmentation", "allOf": [ { "$ref": "#/components/schemas/PanelQuery" }, { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "scope": { "$ref": "#/components/schemas/DashboardV3BasicQueryScope" }, "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" }, "displayedValue": { "type": "string", "description": "Indicates if the value will be the latest available one or an aggregation on the entire time range", "enum": [ "entireRange", "latest" ] }, "metrics": { "type": "array", "description": "List of metrics to be displayed for the query", "items": { "$ref": "#/components/schemas/DashboardV3Metric" } } } } ] }, "DashboardV3BasicQueryScope": { "required": [ "expressions", "extendsDashboardScope" ], "type": "object", "properties": { "expressions": { "type": "array", "description": "Filtering/scopes for the query. Data result will be filtered by the scope", "items": { "$ref": "#/components/schemas/DashboardV3ScopeExpression" } }, "extendsDashboardScope": { "type": "boolean", "description": "States whether the query should make use of the dashboard defined scope", "example": true } }, "description": "Scope/filtering for a given panel query" }, "DashboardV3BasicQuerywithdataboundaries": { "required": [ "compareTo", "dataBoundaries", "displayInfo", "enabled", "format", "metrics", "scope" ], "type": "object", "properties": { "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" }, "dataBoundaries": { "$ref": "#/components/schemas/DashboardV3GaugePanelDataBoundaries" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "displayedValue": { "type": "string", "description": "Indicates if the value will be the latest available one or an aggregation on the entire time range", "enum": [ "entireRange", "latest" ] }, "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "metrics": { "type": "array", "description": "List of metrics to be displayed for the query", "items": { "$ref": "#/components/schemas/DashboardV3Metric" } }, "scope": { "$ref": "#/components/schemas/DashboardV3BasicQueryScope" } }, "description": "Basic query making use of form with data boundaries" }, "DashboardV3EventDisplayQueryParams": { "type": "object", "properties": { "alertStatuses": { "type": "array", "description": "Display only events matching the statuses", "example": "unacknowledged", "items": { "type": "string", "description": "Display only events matching the statuses", "example": "unacknowledged", "enum": [ "acknowledged", "unacknowledged", "triggered", "resolved" ] }, "enum": [ "acknowledged", "unacknowledged", "triggered", "resolved" ] }, "categories": { "type": "array", "description": "Display only events matching the categories", "example": "alert", "items": { "type": "string", "description": "Display only events matching the categories", "example": "alert", "enum": [ "alert", "custom", "kubernetes", "containers" ] }, "enum": [ "alert", "custom", "kubernetes", "containers" ] }, "filter": { "type": "string", "description": "Free text search for the event content" }, "severities": { "type": "array", "description": "Display only events matching the severities", "items": { "type": "string", "description": "Display only events matching the severities", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] } }, "teamScope": { "type": "boolean", "description": "Applies team scope to the event filtering" } }, "description": "Configuration for event filtering" }, "DashboardV3EventDisplaySettings": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enables the event display in the UI" }, "queryParams": { "$ref": "#/components/schemas/DashboardV3EventDisplayQueryParams" } }, "description": "Event display settings for the dashboard in the UI" }, "DashboardV3FavoriteDTO": { "type": "object", "properties": { "favorite": { "type": "boolean", "description": "States whether the dashboard must be set as favorite for the current user" } } }, "DashboardV3FullDashboardDTOsWrapper": { "type": "object", "properties": { "dashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3Payload" } } } }, "DashboardV3GaugePanelDataBoundaries": { "required": [ "max", "min" ], "type": "object", "properties": { "max": { "$ref": "#/components/schemas/DashboardV3GaugePanelDataBoundary" }, "min": { "$ref": "#/components/schemas/DashboardV3GaugePanelDataBoundary" } }, "description": "Defines the boundaries for the Gauge panel" }, "DashboardV3GaugePanelDataBoundary": { "required": [ "inputFormat", "type" ], "type": "object", "properties": { "inputFormat": { "type": "string", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "type": { "type": "string", "description": "Set the type of the boundary", "enum": [ "static" ] }, "value": { "type": "number", "description": "Value of the boundary, if not set managed as auto", "format": "double" } }, "description": "Defines the boundaries for the panel" }, "DashboardV3GaugePanelThresholds": { "required": [ "base", "values" ], "type": "object", "properties": { "base": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholdBase" }, "showLabels": { "type": "boolean", "description": "Show thresholds values near the markers" }, "showMarkers": { "type": "boolean", "description": "Show the thresholds marker" }, "useDefaults": { "type": "boolean", "description": "Make use of defaults values for thresholds" }, "values": { "type": "array", "description": "Set of thresholds to be considered in order to apply custom display", "items": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholdValue" } } }, "description": "Defines a threshold and display for a gauge panel" }, "DashboardV3HistogramConfiguration": { "required": [ "inputFormat", "numBuckets" ], "type": "object", "properties": { "inputFormat": { "type": "string", "description": "Input format for the incoming data", "example": "auto", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "maxValue": { "type": "number", "description": "Max value to be displayed on Histogram. Set as 'null' for 'auto'", "format": "double" }, "minValue": { "type": "number", "description": "Min value to be displayed on Histogram. Set as 'null' for 'auto'", "format": "double" }, "numBuckets": { "maximum": 50, "minimum": 1, "type": "integer", "description": "Number of buckets displayed for the dashboard. Data is collected and summed for a bucket range", "format": "int32" } }, "description": "Histogram panel configuration" }, "DashboardV3HistogramSegmentedBasicQuery": { "required": [ "compareTo", "displayInfo", "enabled", "format", "histogramConfiguration", "metrics", "scope", "segmentation" ], "type": "object", "properties": { "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "displayedValue": { "type": "string", "description": "Indicates if the value will be the latest available one or an aggregation on the entire time range", "enum": [ "entireRange", "latest" ] }, "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "histogramConfiguration": { "$ref": "#/components/schemas/DashboardV3HistogramConfiguration" }, "metrics": { "type": "array", "description": "List of metrics to be displayed for the query", "items": { "$ref": "#/components/schemas/DashboardV3Metric" } }, "scope": { "$ref": "#/components/schemas/DashboardV3BasicQueryScope" }, "segmentation": { "$ref": "#/components/schemas/DashboardV3Segmentation" } }, "description": "Basic form query with segmentation for histogram panels" }, "DashboardV3LightDashboardDTO": { "type": "object", "properties": { "createdOn": { "type": "integer", "description": "Creation time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "readOnly": true, "example": 1630326638135 }, "description": { "type": "string", "description": "Dashboard's description, displayed on UX popup for detailed information", "example": "This Dashboard tracks the CPU usage of a cluster" }, "favorite": { "type": "boolean", "description": "Flags if the dashboard is set as favorite for the current user", "readOnly": true }, "id": { "type": "integer", "description": "Dashboard's unique id.", "format": "int64" }, "lastAccessedOnByCurrentUser": { "type": "integer", "format": "int64" }, "modifiedOn": { "type": "integer", "description": "Last modified time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "readOnly": true, "example": 1630326638135 }, "name": { "type": "string", "description": "Dashboard's name, used on menus and titles", "example": "Dashboard Name" }, "panels": { "type": "array", "description": "Optional list of dashboard panels", "items": { "$ref": "#/components/schemas/PanelLight" } }, "public": { "type": "boolean" }, "publicToken": { "type": "string", "description": "Public token used in public dashboards", "readOnly": true }, "rankingScore": { "type": "number", "format": "double" }, "schema": { "type": "integer", "description": "Dashboard schema version, fixed to 3", "format": "int32", "enum": [ 3 ] }, "shared": { "type": "boolean", "description": "Flags if the dashboard is shared to another team", "readOnly": true }, "sharingSettings": { "type": "array", "description": "Team's sharing settings for the dashboard", "items": { "$ref": "#/components/schemas/DashboardV3SharingSettings" } }, "teamId": { "type": "integer", "description": "Read only Dashboard's team id", "format": "int32", "readOnly": true, "example": 1 }, "userId": { "type": "integer", "description": "Read only Dashboard's internal owner's user id", "format": "int32", "readOnly": true, "example": 123 }, "username": { "type": "string", "description": "Read only owner's username", "readOnly": true, "example": "john.smith@example.com" }, "version": { "type": "integer", "description": "Incremental version for updates, required on update operation", "format": "int64", "example": 1 } }, "description": "Light description of dashboards without its panels and layout info" }, "DashboardV3Metric": { "required": [ "Metric ID", "groupAggregation", "timeAggregation" ], "type": "object", "properties": { "Metric ID": { "type": "string" }, "groupAggregation": { "type": "string", "description": "Aggregation to be applied over groups/segments", "example": "sum", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "sorting": { "$ref": "#/components/schemas/DashboardV3Sorting" }, "timeAggregation": { "type": "string", "description": "Aggregation to be applied over time", "example": "avg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } }, "description": "Metric definition for a basic query" }, "DashboardV3NumberPanelThresholdBase": { "required": [ "severity" ], "type": "object", "properties": { "displayText": { "type": "string", "description": "Display text for the panel when no threshold is met", "example": "Cluster is down" }, "severity": { "type": "string", "description": "Severity label driving color display for the number panel", "example": "high", "enum": [ "none", "info", "ok", "low", "medium", "high" ] } }, "description": "Information about custom display when there is no matching for threshold values" }, "DashboardV3NumberPanelThresholdValue": { "required": [ "inputFormat", "severity", "value" ], "type": "object", "properties": { "displayText": { "type": "string", "description": "Display text for the following threshold", "example": "Pods are ready" }, "inputFormat": { "type": "string", "description": "Data input format for the threshold", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "severity": { "type": "string", "description": "Drives the coloring for the number panel according to the severity", "example": "low", "enum": [ "none", "info", "ok", "low", "medium", "high" ] }, "value": { "type": "number", "description": "Value to be used as threshold to be applied. Ranges are comparative to other thresholds set including base ones", "format": "double", "example": 50 } }, "description": "Single threshold definition for a number panel" }, "DashboardV3NumberPanelThresholds": { "required": [ "base", "values" ], "type": "object", "properties": { "base": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholdBase" }, "useDefaults": { "type": "boolean", "description": "Make use of defaults values for thresholds" }, "values": { "type": "array", "description": "Set of thresholds to be considered in order to apply custom display", "items": { "$ref": "#/components/schemas/DashboardV3NumberPanelThresholdValue" } } }, "description": "Defines a threshold and display for a number panel" }, "DashboardV3Panel": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "description": { "type": "string", "description": "Panel description displayed as info icon", "example": "CPU Usage per pod over all the clusters, filtering namespaces" }, "id": { "minimum": 1, "type": "integer", "description": "Unique sequential panel id", "format": "int32", "example": 1 }, "links": { "type": "array", "description": "Panel links, applicable only for PromQL table panels", "items": { "$ref": "#/components/schemas/DashboardV3PanelLink" } }, "name": { "type": "string", "description": "Panel name displayed as title", "example": "CPU Usage per pod" }, "nullValueDisplayText": { "type": "string", "description": "Text to be displayed when data is null, applicable only for number panels", "example": "Data not available" }, "type": { "type": "string", "description": "Defines the panel display type. 'Advanced' panels make use of PromQL while 'Basic' ones make use of selected metrics and labels", "example": "basicTimechart", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text" ] } }, "description": "Dashboard panel. Check subtypes for detailed information on each panel", "discriminator": { "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/DashboardV3AdvancedGaugePanel" }, { "$ref": "#/components/schemas/DashboardV3AdvancedNumberPanel" }, { "$ref": "#/components/schemas/DashboardV3AdvancedPiechartPanel" }, { "$ref": "#/components/schemas/DashboardV3AdvancedTablePanel" }, { "$ref": "#/components/schemas/DashboardV3AdvancedTimechartPanel" }, { "$ref": "#/components/schemas/DashboardV3AdvancedToplistPanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormGaugePanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormHistogramPanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormNumberPanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormPiechartPanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormTablePanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormTimechartPanel" }, { "$ref": "#/components/schemas/DashboardV3BasicFormTopListPanel" }, { "$ref": "#/components/schemas/DashboardV3TextPanel" } ] }, "DashboardV3PanelAxisConfiguration": { "required": [ "displayFormat", "enabled", "maxInputFormat", "minInputFormat", "scale", "unit" ], "type": "object", "properties": { "decimals": { "maximum": 6, "minimum": 0, "type": "integer", "description": "Number of decimals to be displayed for the axis", "format": "int32" }, "displayFormat": { "type": "string", "description": "Overrides data input display format", "example": "0-100", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "displayName": { "type": "string", "description": "Display name for the axis, to be displayed side wise", "example": "Percentage usage" }, "enabled": { "type": "boolean", "description": "Whether the axis is enabled" }, "maxInputFormat": { "type": "string", "description": "Scale mode for the axis max value. It must match the selected unit", "example": "0-100", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "maxValue": { "type": "number", "description": "Max value for the axis", "format": "double", "example": 80 }, "minInputFormat": { "type": "string", "description": "Scale mode for the axis min value. It must match the selected unit", "example": "0-100", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "minValue": { "type": "number", "description": "Min value for the axis", "format": "double", "example": 0 }, "scale": { "type": "string", "description": "Scale mode for the axis, default to linear", "example": "linear", "enum": [ "linear", "log2", "log10", "log32", "log1024", "exponential" ] }, "unit": { "type": "string", "description": "Overrides data input format. 'auto' inherits the query data input.", "example": "%", "enum": [ "auto", "byte", "byteRate", "number", "numberRate", "%", "relativeTime", "tag", "currency" ] } }, "description": "Timechart panel axis configuration" }, "DashboardV3PanelLayout": { "required": [ "h", "panelId", "w", "x", "y" ], "type": "object", "properties": { "h": { "minimum": 1, "type": "integer", "description": "Panel's height", "format": "int32" }, "panelId": { "minimum": 1, "type": "integer", "description": "Must match the dashboard's panel unique id", "format": "int32" }, "w": { "maximum": 24, "minimum": 1, "type": "integer", "description": "Panel's width", "format": "int32" }, "x": { "maximum": 23, "minimum": 0, "type": "integer", "description": "Panel's vertical position in the layout grid", "format": "int32" }, "y": { "minimum": 0, "type": "integer", "description": "Panel's horizontal position in the layout grid", "format": "int32" } }, "description": "Layout definition for a given dashboard panel" }, "DashboardV3PanelLegendConfiguration": { "required": [ "enabled", "layout", "position", "showCurrent" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether to display the legend for the panel", "example": true }, "height": { "type": "string", "description": "Optional legend height applicable when position is set to bottom" }, "layout": { "type": "string", "description": "Legend display layout", "example": "table", "enum": [ "table", "inline" ] }, "position": { "type": "string", "description": "Positioning of the legend related to the panel data", "example": "bottom", "enum": [ "bottom", "right" ] }, "showCurrent": { "type": "boolean", "description": "Display latest value of the timeseries" }, "showMax": { "type": "boolean", "description": "Display max value of the timeseries" }, "showMin": { "type": "boolean", "description": "Display min value of the timeseries" }, "width": { "type": "string", "description": "Optional legend width applicable when position is set to right" } }, "description": "Legend setup for a timechart panel" }, "DashboardV3PanelLink": { "required": [ "title", "type" ], "type": "object", "properties": { "title": { "type": "string", "description": "Defines the link description." }, "type": { "type": "string", "description": "Defines the panel link type.", "example": "url", "enum": [ "url" ] } }, "description": "Dashboard panel link. Check subtypes for detailed information on each link", "discriminator": { "propertyName": "type" } }, "DashboardV3PanelQueryFormat": { "required": [ "displayFormat", "getyAxis", "inputFormat", "unit" ], "type": "object", "properties": { "decimals": { "maximum": 6, "minimum": 0, "type": "integer", "description": "Max number of decimals to be displayed for each datapoint", "format": "int32" }, "displayFormat": { "type": "string", "description": "Overrides display data format, must match the selected input unit. 'auto' is allowed and default", "example": "KiB", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "getyAxis": { "type": "string", "description": "Selects which YAxis to be used for displaying over a timechart", "enum": [ "auto", "left", "right" ] }, "inputFormat": { "type": "string", "description": "Input data format, must match the selected input unit. 'auto' is not allowed except for dashboard libraries", "example": "MiB", "enum": [ "auto", "B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "B/s", "KiB/s", "MiB/s", "GiB/s", "TiB/s", "PiB/s", "EiB/s", "ZiB/s", "1", "K", "M", "G", "T", "P", "E", "Z", "/s", "K/s", "M/s", "G/s", "T/s", "P/s", "E/s", "Z/s", "0-100", "0-1", "ns", "µs", "ms", "s", "m", "h", "d", "tag" ] }, "minInterval": { "type": "string", "description": "Minimum interval to be used as a replacement of the $__interval variable in PromQL queries", "example": "60s" }, "nullValueDisplayMode": { "type": "string", "description": "Defines the timechart behavior for missing datapoints", "example": "nullGap", "enum": [ "nullGap", "nullZero", "connectSolid", "connectDotted" ] }, "unit": { "type": "string", "description": "Input data unit. 'auto' is not allowed except for dashboard libraries", "example": "byte", "enum": [ "auto", "byte", "byteRate", "number", "numberRate", "%", "relativeTime", "tag", "currency" ] } }, "description": "Panel query input and display formating" }, "DashboardV3Panelquerycomparisonfortimechartandnumberpanels": { "required": [ "delta", "enabled", "timeFormat" ], "type": "object", "properties": { "delta": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Delta for the past time comparison, related to the selected time format", "format": "int32", "example": 7 }, "enabled": { "type": "boolean", "description": "States whether comparison should be performed" }, "timeFormat": { "type": "string", "description": "Time unit format for the delta to be applied", "example": "day", "enum": [ "hour", "day", "week", "month" ] } }, "description": "Query comparison with past data for timechart and number panels" }, "DashboardV3Panelquerydisplayinfo": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name to be used instead of raw query", "example": "Sum of containers" }, "timeSeriesDisplayNameTemplate": { "type": "string", "description": "Timeseries display name, displayed for each timeseries yielded by the query. May make use of labels markers between double brackets", "example": "Container {{container_id}}" }, "type": { "type": "string", "description": "Display Type applicable only for timechart panels", "example": "lines", "enum": [ "lines", "stackedArea", "stackedBar" ] } }, "description": "Panel query display info" }, "DashboardV3Payload": { "required": [ "layout", "panels" ], "type": "object", "properties": { "createdOn": { "type": "integer", "description": "Creation time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "readOnly": true, "example": 1630326638135 }, "description": { "type": "string", "description": "Dashboard's description, displayed on UX popup for detailed information", "example": "This Dashboard tracks the CPU usage of a cluster" }, "eventDisplaySettings": { "$ref": "#/components/schemas/DashboardV3EventDisplaySettings" }, "favorite": { "type": "boolean", "description": "Read only flag stating whether its flagged as favorite for the current logged user", "readOnly": true }, "id": { "type": "integer", "description": "Dashboard's unique id. Mandatory on update/delete operations", "format": "int64" }, "layout": { "type": "array", "description": "Panel layouts setup for the dashboard grid display", "items": { "$ref": "#/components/schemas/DashboardV3PanelLayout" } }, "minInterval": { "type": "string", "description": "Time duration used as a minimum interval for the replacement of $__interval in the PromQL queries", "example": "60s" }, "modifiedOn": { "type": "integer", "description": "Last modified time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "readOnly": true, "example": 1630326638135 }, "name": { "type": "string", "description": "Dashboard's name, used on menus and titles", "example": "Dashboard Name" }, "panels": { "maxItems": 100, "minItems": 0, "type": "array", "description": "List of Dashboard panels. The number of panels must match the number of layouts. Max 100 panels.", "items": { "$ref": "#/components/schemas/DashboardV3Panel" } }, "permissions": { "uniqueItems": true, "type": "array", "description": "Read only resolved permissions for the dashboard for the current user", "readOnly": true, "example": [ "dashboards.read", "dashboards.edit", "dashboards.delete", "dashboards.sharing", "dashboards.transfer" ], "items": { "type": "string", "description": "Read only resolved permissions for the dashboard for the current user", "readOnly": true, "example": "[\"dashboards.read\",\"dashboards.edit\",\"dashboards.delete\",\"dashboards.sharing\",\"dashboards.transfer\"]", "enum": [ "dashboards.delete", "dashboards.edit", "dashboards.read", "dashboards.sharing", "dashboards.transfer" ] } }, "public": { "type": "boolean", "description": "Flags whether the dashboard is shared publicly to any user with the link", "readOnly": true }, "publicToken": { "type": "string", "description": "Read only generated public token used only in public shared dashboards", "readOnly": true, "example": "11b0adda52124df59022c15b03572510" }, "schema": { "type": "integer", "description": "Dashboard schema version, fixed to 3", "format": "int32", "enum": [ 3 ] }, "scopeExpressionList": { "type": "array", "description": "Scope expressions at dashboard level. Defines the preset of filters applied to the dashboard", "items": { "$ref": "#/components/schemas/DashboardV3ScopeExpression" } }, "shared": { "type": "boolean", "description": "Flags if the dashboard is shared to another team", "readOnly": true }, "sharingSettings": { "type": "array", "description": "Team's sharing settings for the dashboard", "items": { "$ref": "#/components/schemas/DashboardV3SharingSettings" } }, "teamId": { "type": "integer", "description": "Read only Dashboard's team id", "format": "int32", "readOnly": true, "example": 1 }, "userId": { "type": "integer", "description": "Read only Dashboard's internal owner's user id", "format": "int32", "readOnly": true, "example": 123 }, "username": { "type": "string", "description": "Read only owner's username", "readOnly": true, "example": "john.smith@example.com" }, "version": { "type": "integer", "description": "Incremental version for updates, required on update operation", "format": "int64", "example": 1 } } }, "DashboardV3ScopeExpression": { "required": [ "displayName", "operand", "operator" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "States the display name for the filtering. If set as variable, then it represents too the variable name which can be used on PromQL panels", "example": "clusterName" }, "isVariable": { "type": "boolean", "description": "States whether the end user can select values" }, "operand": { "type": "string", "description": "Label id used for scope filtering", "example": "kube_cluster_name" }, "operator": { "type": "string", "description": "Operator to be used when comparing the label to its values", "example": "in", "enum": [ "equals", "notEquals", "in", "notIn", "contains", "notContains", "startsWith" ] }, "value": { "type": "array", "description": "List of values, depending on selected operator and operand", "example": "cluster_a, cluster_b", "items": { "type": "string", "description": "List of values, depending on selected operator and operand", "example": "cluster_a, cluster_b" } }, "variable": { "type": "boolean" } }, "description": "Scope/filtering expression for a panel or dashboard" }, "DashboardV3Segmentation": { "required": [ "labels" ], "type": "object", "properties": { "direction": { "type": "string", "description": "Sorting direction of labels", "enum": [ "asc", "desc" ] }, "labels": { "type": "array", "description": "Metric ids to be used as segmentation", "items": { "$ref": "#/components/schemas/DashboardV3SegmentationLabel" } }, "limit": { "type": "integer", "description": "Maximum number of segmentation to be applied", "format": "int32" } }, "description": "Segmentation/grouping definition for a panel query" }, "DashboardV3SegmentationLabel": { "required": [ "id" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "Alternative display name instead of the label id", "example": "Cluster name" }, "id": { "type": "string", "description": "The label id for segmentation/grouping", "example": "kube_cluster_name" }, "sorting": { "$ref": "#/components/schemas/DashboardV3Sorting" } }, "description": "Single segmentation/grouping definition" }, "DashboardV3SegmentedBasicQuery": { "required": [ "compareTo", "displayInfo", "enabled", "format", "metrics", "scope", "segmentation" ], "type": "object", "description": "Basic form query with segmentation", "allOf": [ { "$ref": "#/components/schemas/DashboardV3BasicQuery" }, { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" }, "scope": { "$ref": "#/components/schemas/DashboardV3BasicQueryScope" }, "compareTo": { "$ref": "#/components/schemas/DashboardV3Panelquerycomparisonfortimechartandnumberpanels" }, "metrics": { "type": "array", "description": "List of metrics to be displayed for the query", "items": { "$ref": "#/components/schemas/DashboardV3Metric" } }, "displayedValue": { "type": "string", "description": "Indicates if the value will be the latest available one or an aggregation on the entire time range", "enum": [ "entireRange", "latest" ] }, "segmentation": { "$ref": "#/components/schemas/DashboardV3Segmentation" } } } ] }, "DashboardV3SharingMemberSettings": { "type": "object", "properties": { "id": { "type": "integer", "description": "Team Id mandatory only for TEAM type", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "Team name present only for TEAM type, readonly", "readOnly": true, "example": "Team A" }, "teamTheme": { "type": "string", "description": "Team color theme present only for TEAM type, readonly", "readOnly": true, "example": "blue" }, "type": { "type": "string", "description": "Team for sharing for a specific team. USER_TEAMS for sharing to all the teams the user has acccess to", "example": "USER_TEAMS", "enum": [ "TEAM", "USER_TEAMS" ] } }, "description": "Target team setup of a dashboard sharing" }, "DashboardV3SharingSettings": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/DashboardV3SharingMemberSettings" }, "role": { "type": "string", "description": "Sharing role permission, either Edit(Collaborator) or Read only (READ)", "example": "ROLE_RESOURCE_EDIT", "enum": [ "ROLE_RESOURCE_EDIT", "ROLE_RESOURCE_READ" ] } }, "description": "Settings to allow the dashboard sharing to certain teams" }, "DashboardV3Sorting": { "type": "object", "properties": { "direction": { "type": "string", "description": "Whether top/asc or bottom/desc results must be returned", "example": "asc", "enum": [ "asc", "desc" ] }, "index": { "type": "integer", "description": "Max number of segments/groups to be returned", "format": "int32" } }, "description": "Sorting configuration for segmented/grouped panel results" }, "DashboardV3TextPanel": { "required": [ "id", "markdownSource", "name", "type" ], "type": "object", "description": "Text Panel", "allOf": [ { "$ref": "#/components/schemas/DashboardV3Panel" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text", "text" ] }, "markdownSource": { "type": "string", "description": "Content for the text panel. May contain markdown content", "example": "Number of **namespaces** per cluster" }, "transparentBackground": { "type": "boolean", "description": "Use transparent background for the panel" }, "panelTitleVisible": { "type": "boolean", "description": "Whether to display the title for the panel or only its content" }, "textAutosized": { "type": "boolean", "description": "Auto sizes panel font size according to its width/height" } } } ] }, "DashboardV3TimechartpanelAxisConfiguration": { "required": [ "bottom", "left", "right" ], "type": "object", "properties": { "bottom": { "$ref": "#/components/schemas/DashboardV3TimechartpanelBottomaxisConfiguration" }, "left": { "$ref": "#/components/schemas/DashboardV3PanelAxisConfiguration" }, "right": { "$ref": "#/components/schemas/DashboardV3PanelAxisConfiguration" } }, "description": "Axes setup for a timechart panel" }, "DashboardV3TimechartpanelBottomaxisConfiguration": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enabled per default" } }, "description": "Bottom timechart axis configuration" }, "DashboardV3Transferrequest": { "required": [ "dashboardIdsToBeTransferred" ], "type": "object", "properties": { "dashboardIdsToBeTransferred": { "type": "array", "description": "The dashboard ids to be transferred", "items": { "type": "integer", "description": "The dashboard ids to be transferred", "format": "int64" } }, "ownerId": { "type": "integer", "description": "The current dashboard owner user id", "format": "int32" }, "simulate": { "type": "boolean", "description": "Only simulate the transfer, resolving all sharing" }, "targetOwnerId": { "type": "integer", "description": "The new dashboard owner user id", "format": "int32" } }, "description": "Transfer of ownership for a dashboard" }, "Dashboard V3 URL Panel Link. Used to open internal or external url, the url can use the data obtained from queries.": { "required": [ "title", "type", "url" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardV3PanelLink" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url", "url" ] }, "url": { "type": "string", "description": "Url template, used for each result yielded by the query. May make use of labels markers between double brackets", "example": "http://www.google.com?q={{container_id}}" } } } ] }, "Dashboardtransferevaluationresult": { "type": "object", "properties": { "currentTeamId": { "type": "integer", "format": "int32" }, "currentTeamName": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "privateDashboard": { "type": "boolean" }, "sharingSettingsExcluded": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3SharingSettings" } }, "sharingSettingsKept": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3SharingSettings" } }, "targetTeamId": { "type": "integer", "format": "int32" }, "targetTeamName": { "type": "string" } } }, "Dashboardtransferevaluationresults": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboardtransferevaluationresult" } } } }, "DashboardPatchRequestWrapper": { "type": "object", "properties": { "dashboard": { "$ref": "#/components/schemas/DashboardV3FavoriteDTO" } } }, "DashboardPopularityDTO": { "type": "object", "properties": { "dashboardId": { "type": "integer", "format": "int64" }, "dashboardTemplateId": { "type": "string" }, "lastAccessedOn": { "type": "integer", "format": "int64" }, "rankingScore": { "type": "number", "format": "double" }, "totalHits": { "type": "integer", "format": "int32" }, "uniqueUsers": { "type": "integer", "format": "int32" } } }, "DashboardTrackingInfoDto": { "type": "object", "properties": { "counter": { "type": "integer", "format": "int64" }, "dashboardId": { "type": "integer", "format": "int64" }, "dashboardTemplateId": { "type": "string" }, "lastAccessedOn": { "type": "integer", "format": "int64" } } }, "DashboardV2": { "required": [ "eventsOverlaySettings", "widgets" ], "type": "object", "properties": { "autoCreated": { "type": "boolean" }, "createdOn": { "type": "integer", "description": "Creation time in milliseconds", "format": "int64" }, "customerId": { "type": "integer", "format": "int32" }, "deletedOwnerUsername": { "type": "string" }, "domain": { "type": "string" }, "eventsOverlaySettings": { "$ref": "#/components/schemas/EventsOverlaySettings" }, "id": { "type": "integer", "description": "Unique ID. Must be null when creating a new one.", "format": "int64" }, "migrationErrors": { "type": "array", "items": { "type": "string" } }, "modifiedOn": { "type": "integer", "description": "Last modification time in milliseconds", "format": "int64" }, "name": { "type": "string" }, "public": { "type": "boolean" }, "publicToken": { "type": "string" }, "schema": { "type": "integer", "format": "int32" }, "scope": { "type": "string" }, "scopeExpressionList": { "type": "array", "items": { "$ref": "#/components/schemas/ScopeExpressionV2" } }, "shared": { "type": "boolean" }, "teamId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "description": "Object version. Must be null when creating a new one.", "format": "int64" }, "widgets": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" } } } }, "DashboardV2Wrapper": { "required": [ "dashboard" ], "type": "object", "properties": { "dashboard": { "$ref": "#/components/schemas/DashboardV2" } } }, "DashboardV3Wrapper": { "required": [ "dashboard" ], "type": "object", "properties": { "dashboard": { "$ref": "#/components/schemas/DashboardV3Payload" } } }, "DashboardWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "showAs" ], "type": "object", "properties": { "customDisplayOptions": { "$ref": "#/components/schemas/CustomDisplayOptions" }, "gridConfiguration": { "$ref": "#/components/schemas/GridConfiguration" }, "name": { "type": "string" }, "showAs": { "type": "string", "enum": [ "timeSeries", "timeSeriesArea", "top", "histogram", "segmentedHistogram", "table", "map", "summary", "text" ] } }, "discriminator": { "propertyName": "showAs" }, "oneOf": [ { "$ref": "#/components/schemas/DataWidget" }, { "$ref": "#/components/schemas/ComparableDataWidget" }, { "$ref": "#/components/schemas/MapWidget" }, { "$ref": "#/components/schemas/SummaryComparableDataWidget" }, { "$ref": "#/components/schemas/TextWidget" } ] }, "DataWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "metrics", "showAs" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardWidget" } ], "oneOf": [ { "$ref": "#/components/schemas/ComparableDataWidget" }, { "$ref": "#/components/schemas/MapWidget" }, { "$ref": "#/components/schemas/SummaryComparableDataWidget" } ] }, "DeleteManyRequestDto": { "required": [ "customTeamRolesIds" ], "type": "object", "properties": { "customTeamRolesIds": { "uniqueItems": true, "type": "array", "description": "The list of custom team roles IDs to be deleted", "example": [ 1, 2, 3 ], "items": { "type": "integer", "description": "The list of custom team roles IDs to be deleted", "format": "int64" } } }, "description": "Body containing the list of roles to be deleted" }, "DependenciesPermissionDto": { "type": "object", "properties": { "dependencies": { "uniqueItems": true, "type": "array", "description": "List of dependencies that are needed to make this permission work properly.", "items": { "type": "string", "description": "List of dependencies that are needed to make this permission work properly." } }, "permissionAuthority": { "type": "string", "description": "Authority string", "example": "dashboards.edit" } }, "description": "Dependencies list for a permission. The resources are identified by the authority string" }, "DowntimeAlertConfigV2DTO": { "required": [ "conditionOperator", "threshold", "timeAggregation" ], "type": "object", "properties": { "conditionOperator": { "type": "string", "description": "The condition operator", "example": ">" }, "duration": { "type": "integer", "description": "A time interval that defines for how long an Alert's condition should be met before an Alert Occurrence is created. Measured in seconds", "format": "int64", "example": 60 }, "groupAggregation": { "type": "string", "description": "The group aggregation", "example": "avg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "mainConditionLabel": { "type": "string", "description": "The main condition label", "example": "Alert" }, "metric": { "$ref": "#/components/schemas/AlertMetricDescriptorV2DTO" }, "metricId": { "type": "string", "description": "The metric id", "example": "sysdig_container_up" }, "noDataBehaviour": { "type": "string", "description": "The way the alert should behave in case no data is retrieved from the storage. Possible values are DO_NOTHING or TRIGGER", "example": "DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER", "DO_NOTHING", "TRIGGER" ] }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } }, "threshold": { "type": "number", "description": "The main threshold", "format": "double", "example": 50 }, "timeAggregation": { "type": "string", "description": "The time aggregation", "example": "timeAvg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "warningConditionLabel": { "type": "string", "description": "The warning condition label", "example": "Warning" }, "warningConditionOperator": { "type": "string", "description": "The warning condition operator", "example": ">" }, "warningThreshold": { "type": "number", "description": "The warning threshold", "format": "double", "example": 25 } }, "description": "Downtime Alert Config V2" }, "DowntimeAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/DOWNTIME" } } }, "EVENT": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "EVENT", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/EventAlertConfigV2DTO" } } } ] }, "Entity": { "type": "object", "properties": { "additionalInfo": { "type": "array", "items": { "type": "object" } }, "eventsQuery": { "$ref": "#/components/schemas/EventsQuery" }, "metricValues": { "type": "array", "items": { "type": "object" } }, "policies": { "type": "array", "items": { "type": "object" } }, "policyEvents": { "type": "array", "items": { "type": "object" } }, "scope": { "type": "string" }, "segment": { "type": "string" }, "thresholds": { "type": "array", "items": { "type": "object" } } } }, "EntityCloneWrapper": { "type": "object", "properties": { "entityIDs": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "EventAlertConfigV2DTO": { "required": [ "conditionOperator", "segmentBy", "tags", "threshold" ], "type": "object", "properties": { "conditionOperator": { "type": "string", "description": "The condition operator", "example": ">" }, "filter": { "type": "string", "description": "Alert filter" }, "mainConditionLabel": { "type": "string", "description": "The main condition label", "example": "Alert" }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } }, "tags": { "uniqueItems": true, "type": "array", "description": "List of event sources to be included", "example": [ "kubernetes", "docker" ], "items": { "type": "string", "description": "List of event sources to be included", "example": "[\"kubernetes\",\"docker\"]" } }, "threshold": { "type": "number", "description": "The main threshold", "format": "double", "example": 50 }, "warningConditionLabel": { "type": "string", "description": "The warning condition label", "example": "Warning" }, "warningConditionOperator": { "type": "string", "description": "The warning condition operator", "example": ">" }, "warningThreshold": { "type": "number", "description": "The warning threshold", "format": "double", "example": 25 } }, "description": "Event Alert Config V2" }, "EventAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/EVENT" } } }, "EventWrapperCUSTOM": { "required": [ "event" ], "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CUSTOM" } } }, "EventWrapperCombinedEvent": { "required": [ "event" ], "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CombinedEvent" } } }, "EventsCountBySample": { "type": "object", "properties": { "eventCounts": { "$ref": "#/components/schemas/EventsCountSeverities" }, "from": { "type": "integer", "format": "int64" }, "to": { "type": "integer", "format": "int64" } } }, "EventsCountDto": { "type": "object", "properties": { "counts": { "type": "array", "items": { "$ref": "#/components/schemas/EventsCountBySample" } } } }, "EventsCountFilterParams": { "required": [ "from", "sampling", "to" ], "type": "object", "properties": { "alertStatus": { "uniqueItems": true, "type": "array", "description": "Alert status (state and/or acknowledgement status) to filter alert events", "example": [ "triggered" ], "items": { "type": "string", "description": "Alert status (state and/or acknowledgement status) to filter alert events", "example": "[\"triggered\"]" } }, "category": { "uniqueItems": true, "type": "array", "description": "Event category (type or source) to filter events", "example": [ "alert" ], "items": { "type": "string", "description": "Event category (type or source) to filter events", "example": "[\"alert\"]" } }, "filter": { "type": "string", "description": "Textual query to search events" }, "from": { "type": "integer", "description": "Start of counting interval (in milliseconds)", "format": "int64" }, "sampling": { "type": "integer", "description": "Sampling interval (in milliseconds)", "format": "int64" }, "scope": { "type": "array", "description": "Scope expressions to filter events", "items": { "$ref": "#/components/schemas/ScopeExpression" } }, "severity": { "uniqueItems": true, "type": "array", "description": "Severity to filter events", "example": [ "MEDIUM" ], "items": { "type": "string", "description": "Severity to filter events", "example": "[\"MEDIUM\"]" } }, "to": { "type": "integer", "description": "End of counting interval (in milliseconds)", "format": "int64" } }, "description": "Parameters to control the event count" }, "EventsCountSeverities": { "type": "object", "properties": { "high": { "type": "integer", "format": "int64" }, "low": { "type": "integer", "format": "int64" }, "medium": { "type": "integer", "format": "int64" }, "none": { "type": "integer", "format": "int64" } } }, "EventsOverlaySettings": { "required": [ "filterNotificationsResolvedFilter", "filterNotificationsSeverityFilter", "filterNotificationsStateFilter", "filterNotificationsTypeFilter", "filterNotificationsUserInputFilter" ], "type": "object", "properties": { "eventOverlayLimit": { "type": "integer", "format": "int32" }, "filterNotificationsResolvedFilter": { "type": "string", "enum": [ "all", "no", "yes" ] }, "filterNotificationsScopeFilter": { "type": "boolean" }, "filterNotificationsSeverityFilter": { "type": "string", "enum": [ "all", "criticalOnly", "excludeLow" ] }, "filterNotificationsStateFilter": { "type": "string", "enum": [ "all", "on", "off" ] }, "filterNotificationsTypeFilter": { "type": "string", "enum": [ "all", "event", "notification" ] }, "filterNotificationsUserInputFilter": { "type": "string" }, "showNotificationsEnabled": { "type": "boolean" } } }, "EventsQuery": { "type": "object", "properties": { "fromMs": { "type": "integer", "format": "int64" }, "metricsQuery": { "type": "string" }, "toMs": { "type": "integer", "format": "int64" } } }, "FORM_BASED_PROMETHEUS": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "FORM_BASED_PROMETHEUS", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/FormBasedPrometheusAlertConfigV2DTO" } } } ] }, "FormBasedPrometheusAlertConfigV2DTO": { "required": [ "conditionOperator", "query", "threshold" ], "type": "object", "properties": { "conditionOperator": { "type": "string", "description": "The condition operator", "example": ">" }, "duration": { "type": "integer", "description": "A time interval that defines for how long an Alert's condition should be met before an Alert Occurrence is created. Measured in seconds", "format": "int64", "example": 60 }, "noDataBehaviour": { "type": "string", "description": "The way the alert should behave in case no data is retrieved from the storage. Possible values are DO_NOTHING or TRIGGER", "example": "DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER", "DO_NOTHING", "TRIGGER" ] }, "query": { "type": "string", "description": "The prometheus query", "example": "sum(max(max_over_time(foo[1h])) by(bar)) by (foo_bar)" }, "threshold": { "type": "number", "description": "The main threshold", "format": "double", "example": 50 }, "warningConditionOperator": { "type": "string", "description": "The warning condition operator", "example": ">" }, "warningThreshold": { "type": "number", "description": "The warning threshold", "format": "double", "example": 25 } }, "description": "Prometheus Form Alert Config V2" }, "FormBasedPrometheusAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/FORM_BASED_PROMETHEUS" } } }, "GROUP_OUTLIERS": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "Alert type": { "type": "string", "example": "GROUP_OUTLIERS", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/GroupOutliersAlertConfigV2DTO" } } } ] }, "GlobalServiceAccountCreateDto": { "required": [ "name", "systemRole" ], "type": "object", "properties": { "expirationDate": { "type": "integer", "description": "[Optional] - Time when the Service Account API key expires, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The display name for Service Account", "example": "CI/CD api token" }, "systemRole": { "pattern": "ROLE_RUNTIME_INSIGHTS|ROLE_CLOUDINGESTION_OKTA|ROLE_CLOUDINGESTION_GITHUB|ROLE_CLOUDINGESTION_GCP|ROLE_PROM_REMOTE_WRITE|ROLE_MANAGE_ACCESS_KEYS|ROLE_MANAGE_CUSTOM_ROLES|ROLE_MANAGE_GROUP_MAPPINGS|ROLE_MANAGE_SSO_SETTINGS|ROLE_USER_PROVISONING|ROLE_USER_ZONE_PROVISIONING", "type": "string", "description": "The system role for Service Account", "example": "ROLE_RUNTIME_INSIGHTS" }, "teamId": { "type": "integer", "format": "int64" } }, "description": "Service Account body used for creation" }, "GridConfiguration": { "type": "object", "properties": { "col": { "maximum": 12, "minimum": 1, "type": "integer", "format": "int32" }, "row": { "minimum": 1, "type": "integer", "format": "int32" }, "size_x": { "minimum": 1, "type": "integer", "format": "int32" }, "size_y": { "minimum": 1, "type": "integer", "format": "int32" } } }, "GroupListWrapper": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/AlertGroup" } } } }, "GroupMappingDto": { "required": [ "groupName", "role" ], "type": "object", "properties": { "groupName": { "type": "string", "description": "The group name to be mapped", "example": "Admins_Mapped_Group" }, "id": { "type": "integer", "description": "Group Mapping ID. Mandatory only on update operations", "format": "int64", "example": 29 }, "role": { "type": "string", "description": "The role that is assigned to the users. It can be a standard role or a custom team role ID", "example": "ROLE_TEAM_STANDARD|40" }, "systemRole": { "type": "string", "description": "The systemRole that is assigned to the users.", "example": "ROLE_CUSTOMER", "enum": [ "ROLE_CUSTOMER", "ROLE_USER" ] }, "teamMap": { "$ref": "#/components/schemas/TeamMapDto" }, "weight": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The weight that is assigned to this group mapping; lower number has higher priority.", "format": "int32", "example": 5, "enum": [ null ] } }, "description": "Group Mapping that maps users IDP groups to Sysdig Teams/Roles" }, "GroupMappingDtoCreate": { "required": [ "groupName", "role" ], "type": "object", "properties": { "groupName": { "type": "string", "description": "The group name to be mapped", "example": "Admins_Mapped_Group" }, "id": { "type": "integer", "description": "Group Mapping ID. Mandatory only on update operations", "format": "int64", "example": 29 }, "role": { "type": "string", "description": "The role that is assigned to the users. It can be a standard role or a custom team role ID", "example": "ROLE_TEAM_STANDARD|40" }, "systemRole": { "type": "string", "description": "The systemRole that is assigned to the users.", "example": "ROLE_CUSTOMER", "enum": [ "ROLE_CUSTOMER", "ROLE_USER" ] }, "teamMap": { "$ref": "#/components/schemas/TeamMapDto" }, "weight": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The weight that is assigned to this group mapping; lower number has higher priority.", "format": "int32", "example": 5, "enum": [ null ] } }, "description": "Group mapping to be created" }, "GroupMappingDtoUpdate": { "required": [ "groupName", "role" ], "type": "object", "properties": { "groupName": { "type": "string", "description": "The group name to be mapped", "example": "Admins_Mapped_Group" }, "id": { "type": "integer", "description": "Group Mapping ID. Mandatory only on update operations", "format": "int64", "example": 29 }, "role": { "type": "string", "description": "The role that is assigned to the users. It can be a standard role or a custom team role ID", "example": "ROLE_TEAM_STANDARD|40" }, "systemRole": { "type": "string", "description": "The systemRole that is assigned to the users.", "example": "ROLE_CUSTOMER", "enum": [ "ROLE_CUSTOMER", "ROLE_USER" ] }, "teamMap": { "$ref": "#/components/schemas/TeamMapDto" }, "weight": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The weight that is assigned to this group mapping; lower number has higher priority.", "format": "int32", "example": 5, "enum": [ null ] } }, "description": "Group mapping to be created" }, "GroupMappingSettingsDto": { "required": [ "differentRolesSameTeamStrategy", "noMappingStrategy" ], "type": "object", "properties": { "differentRolesSameTeamStrategy": { "type": "string", "description": "Strategy for handling different roles on the same team strategy", "example": "FIRST_MATCH", "enum": [ "UNAUTHORIZED", "FIRST_MATCH", "WEIGHTED" ] }, "noMappingStrategy": { "type": "string", "description": "Strategy for handling no mappings", "example": "UNAUTHORIZED", "enum": [ "UNAUTHORIZED", "DEFAULT_TEAM_DEFAULT_ROLE", "NO_MAPPINGS_ERROR_REDIRECT" ] }, "noMappingsErrorRedirectURL": { "type": "string", "description": "Redirect URL where user who doesn't have any allowed group mapping and NO_MAPPINGS_ERROR_REDIRECT strategy is configured" } }, "description": "Settings to be applied to Group Mappings" }, "GroupMappingsDto": { "type": "object", "properties": { "groupMappings": { "type": "array", "description": "List of GroupMappings", "items": { "$ref": "#/components/schemas/GroupMappingDto" } } }, "description": "GroupMappings list that maps users IDP groups to Sysdig Teams/Roles" }, "GroupOutliersAlertConfigV2DTO": { "required": [ "algorithm", "segmentBy" ], "type": "object", "properties": { "algorithm": { "type": "string", "description": "The algorithm to use for group outlier detection", "example": "MAD", "enum": [ "MAD", "DBSCAN", "MAD_SCALED", "DBSCAN_SCALED", "MAD" ] }, "dbscanTolerance": { "type": "number", "description": "The tolerance for DBSCAN algorithm", "format": "float", "example": 3 }, "groupAggregation": { "type": "string", "description": "The group aggregation", "example": "avg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "madThreshold": { "type": "number", "description": "The outlier persistence percentage for MAD algorithm", "format": "float", "example": 15 }, "madTolerance": { "type": "number", "description": "The tolerance for MAD algorithm", "format": "float", "example": 3 }, "metricId": { "type": "string", "description": "The metric id", "example": "sysdig_container_cpu_used_percent" }, "noDataBehaviour": { "type": "string", "description": "The way the alert should behave in case no data is retrieved from the storage. Possible values are DO_NOTHING or TRIGGER", "example": "DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER", "DO_NOTHING", "TRIGGER" ] }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "observationWindow": { "type": "integer", "description": "Observation Window. Measured in seconds", "format": "int64", "example": 60 }, "query": { "type": "string", "description": "The generated prometheus query (READ ONLY)", "readOnly": true, "example": "sum(max(max_over_time(foo[1h])) by(bar)) by (foo_bar)" }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } }, "timeAggregation": { "type": "string", "description": "The time aggregation", "example": "timeAvg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } }, "description": "Group Outlier Alert Config V2" }, "GroupOutliersAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/GROUP_OUTLIERS" } } }, "Histogram": { "type": "object", "properties": { "numberOfBuckets": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32" } } }, "InhibitedBy": { "type": "object", "properties": { "inhibitionRule": { "$ref": "#/components/schemas/InhibitionRule" }, "notificationId": { "type": "integer", "format": "int64" }, "onAlertState": { "type": "string", "enum": [ "TRIGGERED", "RESOLVED" ] }, "ruleVersionedId": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" } }, "description": "If inhibited, information regarding when / what inhibited this alert event" }, "InhibitionRule": { "type": "object", "properties": { "description": { "type": "string" }, "equal": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer", "format": "int64" }, "matchersVersion": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sourceMatchers": { "type": "array", "items": { "$ref": "#/components/schemas/LabelMatcher" } }, "targetMatchers": { "type": "array", "items": { "$ref": "#/components/schemas/LabelMatcher" } } } }, "LEGACY_GROUP_OUTLIER": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "LEGACY_GROUP_OUTLIER", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/LegacyGroupOutlierAlertConfigV2DTO" } } } ] }, "LabelLightDescriptorV3": { "type": "object", "properties": { "allLabels": { "type": "array", "description": "List of all labels found", "items": { "$ref": "#/components/schemas/LightLabelDescriptor" } }, "offset": { "type": "integer", "format": "int32" }, "suggestedLabels": { "type": "array", "description": "List of suggested labels based on allLabels", "items": { "$ref": "#/components/schemas/LightLabelDescriptor" } }, "total": { "type": "integer", "format": "int64" } } }, "LabelCardinalitiesDto": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LightLabelDescriptorWithValueCount" } }, "warnings": { "type": "array", "items": { "type": "string" } } } }, "LabelDescriptorWrapperV3": { "type": "object", "properties": { "labelDescriptor": { "$ref": "#/components/schemas/LightLabelDescriptor" } } }, "LabelId": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } }, "LabelMatcher": { "type": "object", "properties": { "labelName": { "type": "string" }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUALS", "REGEXP_MATCHES", "NOT_REGEXP_MATCHES" ] }, "value": { "type": "string" } } }, "LegacyGroupOutlierAlertConfigV2DTO": { "required": [ "metricIds" ], "type": "object", "properties": { "metricIds": { "type": "array", "description": "List of metric ids", "items": { "type": "string", "description": "List of metric ids" } }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "threshold": { "type": "number", "description": "The threshold", "format": "double" } }, "description": "Legacy Group Outlier Alert Config V2" }, "LightDashboardWrapper": { "type": "object", "properties": { "dashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3LightDashboardDTO" } } } }, "LightLabelDescriptor": { "type": "object", "properties": { "canGroupBy": { "type": "boolean" }, "documented": { "type": "boolean" }, "id": { "type": "string" }, "publicId": { "type": "string" } }, "description": "List of all labels found" }, "LightLabelDescriptorWithValueCount": { "type": "object", "properties": { "canGroupBy": { "type": "boolean" }, "documented": { "type": "boolean" }, "id": { "type": "string" }, "publicId": { "type": "string" }, "valueCount": { "type": "integer", "format": "int64" } } }, "LinkMetric": { "required": [ "id" ], "type": "object", "properties": { "groupAggregation": { "type": "string", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "id": { "type": "string" }, "timeAggregation": { "type": "string", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } } }, "ListAlertWrapper": { "type": "object", "properties": { "alerts": { "type": "array", "description": "List of alerts to create", "items": { "$ref": "#/components/schemas/Alert" } } } }, "LoginBannerDto": { "type": "object", "properties": { "customerId": { "type": "integer", "description": "The owner customer ID", "format": "int64", "example": 17 }, "dateCreated": { "type": "integer", "description": "The creation date in milliseconds", "format": "int64", "example": 1643020108418 }, "enabled": { "type": "boolean", "description": "Login banner enabled flag", "example": true }, "id": { "type": "integer", "description": "The login banner ID", "format": "int64", "example": 3 }, "lastUpdated": { "type": "integer", "description": "The update date in milliseconds", "format": "int64", "example": 1643020113519 }, "message": { "type": "string", "description": "Message in markdown format" } }, "description": "Login Banner definition" }, "LoginBannerRequestDto": { "required": [ "enabled", "message" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Login banner enabled flag", "example": true }, "message": { "type": "string", "description": "Message in markdown format" } }, "description": "The login banner body to create or update for the current logged in user customer" }, "MANUAL": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "MANUAL", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/ManualAlertConfigV2DTO" } } } ] }, "ManualAlertConfigV2DTO": { "required": [ "conditionOperator", "threshold", "timeAggregation" ], "type": "object", "properties": { "conditionOperator": { "type": "string", "description": "The condition operator", "example": ">" }, "duration": { "type": "integer", "description": "A time interval that defines for how long an Alert's condition should be met before an Alert Occurrence is created. Measured in seconds", "format": "int64", "example": 60 }, "groupAggregation": { "type": "string", "description": "The group aggregation", "example": "avg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "mainConditionLabel": { "type": "string", "description": "The main condition label", "example": "Alert" }, "metric": { "$ref": "#/components/schemas/AlertMetricDescriptorV2DTO" }, "metricId": { "type": "string", "description": "The metric id", "example": "sysdig_container_cpu_used_percent" }, "noDataBehaviour": { "type": "string", "description": "The way the alert should behave in case no data is retrieved from the storage. Possible values are DO_NOTHING or TRIGGER", "example": "DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER", "DO_NOTHING", "TRIGGER" ] }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "range": { "type": "integer", "description": "Range of data points considered for the time aggregation. Measured in seconds", "format": "int64", "example": 180 }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } }, "threshold": { "type": "number", "description": "The main threshold", "format": "double", "example": 50 }, "timeAggregation": { "type": "string", "description": "The time aggregation", "example": "timeAvg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "warningConditionLabel": { "type": "string", "description": "The warning condition label", "example": "Warning" }, "warningConditionOperator": { "type": "string", "description": "The warning condition operator", "example": ">" }, "warningThreshold": { "type": "number", "description": "The warning threshold", "format": "double", "example": 25 } }, "description": "Manual Alert Config V2" }, "ManualAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/MANUAL" } } }, "MapWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "metrics", "showAs" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DataWidget" }, { "type": "object", "properties": { "showAs": { "type": "string", "enum": [ "timeSeries", "timeSeriesArea", "top", "histogram", "segmentedHistogram", "table", "map", "summary", "text" ] }, "name": { "type": "string" }, "gridConfiguration": { "$ref": "#/components/schemas/GridConfiguration" }, "customDisplayOptions": { "$ref": "#/components/schemas/CustomDisplayOptions" }, "scope": { "type": "string" }, "overrideScope": { "type": "boolean" }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/WidgetMetric" } }, "limitToScope": { "type": "boolean" }, "linkMetrics": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LinkMetric" } }, "groupingLabelIds": { "type": "array", "items": { "$ref": "#/components/schemas/LabelId" } } } }, { "$ref": "#/components/schemas/DashboardWidget" } ] }, "NotificationChannel": { "type": "object", "properties": { "name": { "type": "string", "description": "The notification channel name" }, "type": { "type": "string", "description": "The notification channel type" } }, "description": "Notification channels associated to the alert when the event was generated" }, "NotificationChannelConfigV2DTO": { "required": [ "channelId" ], "type": "object", "properties": { "channelId": { "type": "integer", "description": "Channel ID", "format": "int64", "example": 1 }, "defaultOptions": { "$ref": "#/components/schemas/NotificationChannelOptionsV2DTO" }, "enabled": { "type": "boolean", "description": "Channel enablement status", "example": true }, "name": { "type": "string", "description": "Channel extended name", "example": "Sample mail channel" }, "options": { "$ref": "#/components/schemas/NotificationChannelOptionsV2DTO" }, "overrideOptions": { "$ref": "#/components/schemas/NotificationChannelOptionsV2DTO" }, "type": { "type": "string", "description": "Channel type", "example": "EMAIL", "enum": [ "EMAIL", "SNS", "SLACK", "PAGER_DUTY", "VICTOROPS", "OPSGENIE", "WEBHOOK", "POWER_WEBHOOK", "IBM_FUNCTION", "MS_TEAMS", "TEAM_EMAIL", "IBM_EVENT_NOTIFICATIONS", "PROMETHEUS_ALERT_MANAGER", "GCHAT", "UNKNOWN" ] } }, "description": "List of notification channels configurations for this alert", "discriminator": { "propertyName": "type" } }, "NotificationChannelDTO": { "type": "object", "properties": { "createdOn": { "type": "integer", "format": "int64" }, "customerId": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "modifiedOn": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "options": { "$ref": "#/components/schemas/NotificationChannelOptionsDTO" }, "sendTestNotification": { "type": "boolean" }, "settingsId": { "type": "integer", "format": "int64" }, "teamId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "version": { "type": "integer", "format": "int64" } } }, "NotificationChannelOptions": { "type": "object", "properties": { "hideSensitiveInfo": { "type": "boolean" }, "notifyOnOk": { "type": "boolean" }, "notifyOnResolve": { "type": "boolean" }, "reNotifyEverySec": { "type": "integer", "format": "int32" }, "templateConfiguration": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TemplateConfiguration" } }, "thresholds": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "MAIN", "WARNING" ] } } } }, "NotificationChannelOptionsDTO": { "type": "object", "properties": { "hideSensitiveInfo": { "type": "boolean" }, "notifyOnOk": { "type": "boolean" }, "notifyOnResolve": { "type": "boolean" }, "reNotifyEverySec": { "type": "integer", "format": "int32" }, "templateConfiguration": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TemplateConfigurationDTO" } }, "thresholds": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "MAIN", "WARNING" ] } } } }, "NotificationChannelOptionsV2DTO": { "type": "object", "properties": { "Custom template specific for this channel": { "$ref": "#/components/schemas/CustomNotificationTemplateV2DTO" }, "Notify on acknowledge flag": { "type": "boolean", "example": true }, "Notify on resolve flag": { "type": "boolean", "example": false }, "Renotify on unresolved interval in seconds": { "type": "integer", "format": "int32", "example": 360 } }, "description": "Notification Channel Options V2" }, "NotificationGroupingConditionV2DTO": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of notification grouping condition. Default to ANY. Accepted values are: ALL (sends one notification, only if all segments trigger the alert), ANY (send one notification for each segment that triggers the alert), COUNT (sends one notification, only if at least segments trigger the alert), PERCENT (sends one notification, only if at least percentage of the segments trigger the alert)", "enum": [ "ALL", "ANY", "COUNT", "PERCENT" ] }, "value": { "type": "number", "description": "Threshold used when type is COUNT or PERCENTAGE", "format": "double" } }, "description": "The notification grouping condition. Controls how many notifications are sent for segmented alerts" }, "NotificationInfoDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "timestamp": { "type": "integer", "format": "int64" } } }, "PERCENTAGE_OF_CHANGE": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "PERCENTAGE_OF_CHANGE", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/PercentageOfChangeAlertConfigV2DTO" } } } ] }, "PROMETHEUS": { "required": [ "config" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/AlertV2" }, { "type": "object", "properties": { "type": { "type": "string", "description": "Alert type", "example": "PROMETHEUS", "enum": [ "ADVANCED_MANUAL", "ANOMALY_DETECTION", "DOWNTIME", "EVENT", "LEGACY_GROUP_OUTLIER", "MANUAL", "PROMETHEUS", "FORM_BASED_PROMETHEUS", "PERCENTAGE_OF_CHANGE", "GROUP_OUTLIERS" ] }, "config": { "$ref": "#/components/schemas/PrometheusAlertConfigV2DTO" } } } ] }, "PanelLight": { "type": "object", "properties": { "metrics": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "advancedGauge", "advancedNumber", "advancedPiechart", "advancedTable", "advancedTimechart", "advancedToplist", "basicGauge", "basicHistogram", "basicNumber", "basicPiechart", "basicTable", "basicTimechart", "basicToplist", "text" ] } }, "description": "Optional list of dashboard panels" }, "PanelQuery": { "required": [ "displayInfo", "enabled", "format" ], "type": "object", "properties": { "displayInfo": { "$ref": "#/components/schemas/DashboardV3Panelquerydisplayinfo" }, "enabled": { "type": "boolean", "description": "States whether the query must be displayed" }, "format": { "$ref": "#/components/schemas/DashboardV3PanelQueryFormat" } }, "oneOf": [ { "$ref": "#/components/schemas/DashboardV3AdvancedQuery" }, { "$ref": "#/components/schemas/DashboardV3BasicQuery" }, { "$ref": "#/components/schemas/DashboardV3SegmentedBasicQuery" } ] }, "PatchAlertV2Wrapper": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/AlertV2" }, "restore": { "type": "boolean" } } }, "PercentageOfChangeAlertConfigV2DTO": { "required": [ "conditionOperator", "segmentBy", "threshold" ], "type": "object", "properties": { "conditionOperator": { "type": "string", "description": "The condition operator", "example": ">" }, "groupAggregation": { "type": "string", "description": "The group aggregation", "example": "avg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "longerRangeSec": { "type": "integer", "description": "The Percentage of Change longer range", "format": "int64", "example": 3600 }, "mainConditionLabel": { "type": "string", "description": "The main condition label", "example": "Alert" }, "metric": { "$ref": "#/components/schemas/AlertMetricDescriptorV2DTO" }, "metricId": { "type": "string", "description": "The metric id", "example": "sysdig_container_cpu_used_percent" }, "noDataBehaviour": { "type": "string", "description": "The way the alert should behave in case no data is retrieved from the storage. Possible values are DO_NOTHING or TRIGGER", "example": "DO_NOTHING", "enum": [ "DO_NOTHING", "TRIGGER", "DO_NOTHING", "TRIGGER" ] }, "notificationGroupingCondition": { "$ref": "#/components/schemas/NotificationGroupingConditionV2DTO" }, "query": { "type": "string", "description": "The generated alert condition to PromQL", "readOnly": true }, "scope": { "$ref": "#/components/schemas/AlertScopeV2DTO" }, "segmentBy": { "type": "array", "description": "List of labels for alert segmentation", "example": [], "items": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" } }, "shorterRangeSec": { "type": "integer", "description": "The Percentage of Change shorter range", "format": "int64", "example": 300 }, "threshold": { "type": "number", "description": "The main threshold", "format": "double", "example": 50 }, "timeAggregation": { "type": "string", "description": "The time aggregation", "example": "timeAvg", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "warningConditionLabel": { "type": "string", "description": "The warning condition label", "example": "Warning" }, "warningConditionOperator": { "type": "string", "description": "The warning condition operator", "example": ">" }, "warningThreshold": { "type": "number", "description": "The warning threshold", "format": "double", "example": 25 } }, "description": "Percentage Of Change Alert Config V2" }, "PercentageOfChangeAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/PERCENTAGE_OF_CHANGE" } } }, "PermissionCategoryDto": { "type": "object", "properties": { "category": { "type": "string", "description": "The name of the category", "example": "CAPTURES" }, "description": { "type": "string", "description": "Additional long description", "example": "Manage access to Captures / Investigate" }, "displayName": { "type": "string", "description": "The name to be displayed in the UI", "example": "Captures / Investigate" } }, "description": "Permission Category response definition" }, "PermissionDto": { "type": "object", "properties": { "action": { "type": "string", "description": "Action representing what can be done in the context of this permission", "example": "READ", "enum": [ "CREATE", "DELETE", "EDIT", "EXEC", "KILL", "MANAGE", "OTHER", "OTHER_MUTATOR", "READ", "SEND", "SHARE", "SIGN", "TOGGLE", "TRANSFER", "UPDATE", "VIEW", "WRITE", "VALIDATE", "APPROVE", "OVERRIDE" ] }, "authority": { "type": "string", "description": "Authority string", "example": "dashboards.edit" }, "category": { "$ref": "#/components/schemas/PermissionCategoryDto" }, "dependees": { "uniqueItems": true, "type": "array", "description": "List of dependees that need this permission to work properly. Check GET /api/permissions to get the list of available values", "example": [ "explore.read" ], "items": { "type": "string", "description": "List of dependees that need this permission to work properly. Check GET /api/permissions to get the list of available values", "example": "[\"explore.read\"]" } }, "dependencies": { "uniqueItems": true, "type": "array", "description": "List of dependencies that are needed to make this permission work properly. Check GET /api/permissions to get the list of available values", "example": [ "dashboards.read" ], "items": { "type": "string", "description": "List of dependencies that are needed to make this permission work properly. Check GET /api/permissions to get the list of available values", "example": "[\"dashboards.read\"]" } }, "description": { "type": "string", "description": "Additional long description", "example": "Enables the user to edit dashboards data" }, "item": { "$ref": "#/components/schemas/PermissionItemDto" }, "products": { "type": "string", "description": "List of products assigned to this permission", "example": "[\"SDC\",\"SDS\"]", "enum": [ "SDC", "SDS" ] } }, "description": "Permission response definition" }, "PermissionItemDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Additional long description", "example": "Infrastructure events or events created via API" }, "displayName": { "type": "string", "description": "The name to be displayed in the UI", "example": "Custom Events" }, "item": { "type": "string", "description": "The name of the authority", "example": "custom-events" } }, "description": "Permission Item response definition" }, "PermissionsResponseDto": { "type": "object", "properties": { "permissions": { "uniqueItems": true, "type": "array", "description": "List of permissions found", "items": { "$ref": "#/components/schemas/PermissionDto" } }, "total": { "type": "integer", "description": "Total number of permissions available", "format": "int64", "example": 34 } }, "description": "Permissions list with count response definition" }, "PrometheusAlertConfigV2DTO": { "required": [ "query" ], "type": "object", "properties": { "duration": { "type": "integer", "description": "A time interval that defines for how long an Alert's condition should be met before an Alert Occurrence is created. Measured in seconds", "format": "int64", "example": 60 }, "keepFiringForSec": { "type": "integer", "description": "The minimum amount of time in seconds that an alert occurrence should remain triggering, after the promQL expression does not return any results", "format": "int64" }, "query": { "type": "string", "description": "The prometheus query", "example": "avg(min_over_time(foo{bar = 'xkcd'}[1m])) > 10" } }, "description": "Prometheus Alert Config V2" }, "PrometheusAlertExample": { "type": "object", "properties": { "alert": { "$ref": "#/components/schemas/PROMETHEUS" } } }, "ResponseWrapperListAlert": { "type": "object", "properties": { "canLoadMore": { "type": "boolean", "writeOnly": true }, "empty": { "type": "boolean" }, "offset": { "type": "integer", "format": "int64", "writeOnly": true }, "total": { "type": "integer", "format": "int64", "writeOnly": true } }, "additionalProperties": { "type": "object" } }, "RoleDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Additional long description", "example": "Enables access to Dashboards section" }, "id": { "type": "integer", "description": "Role ID", "format": "int64", "example": 1 }, "monitorPermissions": { "uniqueItems": true, "type": "array", "description": "Set of Monitor permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": [ "dashboards.read", "dashboards.edit" ], "items": { "type": "string", "description": "Set of Monitor permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": "[\"dashboards.read\",\"dashboards.edit\"]" } }, "name": { "type": "string", "description": "The display name", "example": "Dashboard Read / Write" }, "securePermissions": { "uniqueItems": true, "type": "array", "description": "Set of Secure permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": [ "scanning.read" ], "items": { "type": "string", "description": "Set of Secure permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": "[\"scanning.read\"]" } } }, "description": "Role response definition" }, "RoleRequestBodyDto": { "required": [ "name" ], "type": "object", "properties": { "description": { "type": "string", "description": "Additional long description", "example": "Enables access to Dashboards section" }, "monitorPermissions": { "uniqueItems": true, "type": "array", "description": "Set of Monitor permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": [ "dashboards.read", "dashboards.edit" ], "items": { "type": "string", "description": "Permission assigned to the role", "example": "dashboards.edit" } }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The display name", "example": "Dashboard Read / Write" }, "securePermissions": { "uniqueItems": true, "type": "array", "description": "Set of Secure permissions assigned to the role. Check GET /api/permissions to get the list of available values", "example": [ "scanning.read" ], "items": { "type": "string", "description": "Permission assigned to the role", "example": "dashboards.edit" } } }, "description": "Role body used for creation" }, "RolesResponseDto": { "type": "object", "properties": { "roles": { "type": "array", "description": "List of roles found", "items": { "$ref": "#/components/schemas/RoleDto" } }, "total": { "type": "integer", "description": "Total number of roles available", "format": "int64", "example": 34 } }, "description": "Roles list with count response definition" }, "SYSDIG": { "required": [ "name" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CombinedEvent" }, { "type": "object", "properties": { "id": { "type": "string", "description": "The event id", "readOnly": true }, "version": { "type": "integer", "description": "Event version. Do not specify it when creating new events For an event update to be successful, the value shall match the current value of the existing event.", "format": "int64" }, "name": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Event name. Will be indexed to enable event search", "example": "Jenkins - start wordpress deploy" }, "description": { "type": "string", "description": "Optional event description. If present, will be indexed to enable event search", "example": "deploy" }, "severity": { "type": "string", "description": "Event Severity. Defaults to MEDIUM if not specified", "example": "MEDIUM", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ] }, "scope": { "maxLength": 10000, "minLength": 0, "type": "string", "description": "The event scope. Labels defined in the event scope will be indexed unless \"scopeLabels\" field is explicitly defined", "example": "host.hostName = \"ip-10-1-1-1\" and build = \"89\"" }, "timestamp": { "type": "integer", "description": "The event time in milliseconds. If not specified, current server time will be used", "format": "int64", "readOnly": true }, "createdOn": { "type": "integer", "description": "The time in millisecond when the event was created in the system", "format": "int64", "readOnly": true }, "scopeLabels": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {}, "items": { "type": "string", "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": "{}" } }, "description": "The event scope labels. Labels will be indexed for filtering events by scope. If no value is specified, labels defined in the \"scope\" field will be added to this field", "example": {} }, "source": { "type": "string", "description": "Event source. Will be set to the default value of \"api\" unless it is explicitly specified or a tag with key \"source\" is specified; in the latter case it will take the tag value. If both this field and the \"source\" tag are specified, their value must be the same", "example": "jenkins" }, "tags": { "type": "object", "additionalProperties": { "type": "object", "description": "Custom event tags, i.e. key-value pairs. A default tag with key \"source\" and value \"api\" will be added by the server unless a tag with that key is explicitly specified or the source field is specified; in the latter case a \"source\" tag with the value of the source field will be added.If both the \"source\" tag and the \"source\" field are specified, their value must be the same.", "example": { "source": "jenkins" } }, "description": "Custom event tags, i.e. key-value pairs. A default tag with key \"source\" and value \"api\" will be added by the server unless a tag with that key is explicitly specified or the source field is specified; in the latter case a \"source\" tag with the value of the source field will be added.If both the \"source\" tag and the \"source\" field are specified, their value must be the same.", "example": { "source": "jenkins" } }, "type": { "type": "string", "description": "Event type. Only allowed value for creation/update of events is CUSTOM", "example": "CUSTOM", "enum": [ "ALERT", "CUSTOM", "POLICY", "SCANNING", "SYSDIG" ] } } } ] }, "ScopeExpression": { "type": "object", "properties": { "operand": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "notEquals", "in", "notIn", "contains", "notContains", "startsWith" ] }, "value": { "type": "array", "items": { "type": "string" } } }, "description": "Scope expressions to filter events" }, "ScopeExpressionV2": { "required": [ "displayName", "operand", "operator" ], "type": "object", "properties": { "displayName": { "type": "string", "description": "States the display name for the filtering. If set as variable, then it represents too the variable name which can be used on PromQL panels", "example": "clusterName" }, "isVariable": { "type": "boolean", "description": "States whether the end user can select values" }, "operand": { "type": "string", "description": "Label id used for scope filtering", "example": "kube_cluster_name" }, "operator": { "type": "string", "description": "Operator to be used when comparing the label to its values", "example": "in", "enum": [ "equals", "notEquals", "in", "notIn", "contains", "notContains", "startsWith" ] }, "value": { "type": "array", "description": "List of values, depending on selected operator and operand", "example": "cluster_a, cluster_b", "items": { "type": "string", "description": "List of values, depending on selected operator and operand", "example": "cluster_a, cluster_b" } }, "variable": { "type": "boolean" } } }, "ScopeExpressionV2DTO": { "required": [ "operand", "operator", "value" ], "type": "object", "properties": { "descriptor": { "$ref": "#/components/schemas/AlertLabelDescriptorV2DTO" }, "operand": { "type": "string", "description": "The operand" }, "operator": { "type": "string", "description": "The operator", "enum": [ "equals", "notEquals", "in", "notIn", "contains", "notContains", "startsWith" ] }, "value": { "type": "array", "description": "The value", "items": { "type": "string", "description": "The value" } } }, "description": "Scope Expression" }, "ServiceAccountDto": { "type": "object", "properties": { "customerId": { "type": "integer", "description": "Customer ID", "format": "int64", "example": 21 }, "dateCreated": { "type": "integer", "description": "Creation time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "expirationDate": { "type": "integer", "description": "[Optional] - Time when the Service Account API key expires, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "id": { "type": "integer", "description": "Service Account ID", "format": "int64", "example": 143 }, "lastUpdated": { "type": "integer", "description": "Last modified time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "lastUsed": { "type": "integer", "description": "Time when the Service Account API key was last used, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "name": { "type": "string", "description": "The display name for Service Account", "example": "CI/CD api token" }, "systemRole": { "type": "string", "description": "The system role for Service Account", "example": "ROLE_SERVICE_ACCOUNT" }, "teamId": { "type": "integer", "description": "Team ID", "format": "int64", "example": 21 }, "teamRole": { "type": "string", "description": "The team role for Service Account. It can be string for predefined roles or id of a custom role", "example": "CICD_SCANNING" } }, "description": "Service Account response" }, "ServiceAccountRefreshDto": { "type": "object", "properties": { "expirationDate": { "type": "integer", "description": "Time when the Service Account API key expires, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 } }, "description": "Service Account details used for refresh" }, "ServiceAccountUpdateDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The display name for Service Account", "readOnly": true, "example": "CI/CD api token" } }, "description": "Service Account details used for update" }, "ServiceAccountWithKeyDto": { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Timestamp(epoch, UTC) representing expiration date for the Service Account" }, "customerId": { "type": "integer", "description": "Customer ID", "format": "int64", "example": 21 }, "dateCreated": { "type": "integer", "description": "Creation time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "expirationDate": { "type": "integer", "description": "[Optional] - Time when the Service Account API key expires, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "id": { "type": "integer", "description": "Service Account ID", "format": "int64", "example": 143 }, "lastUpdated": { "type": "integer", "description": "Last modified time, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "lastUsed": { "type": "integer", "description": "Time when the Service Account API key was last used, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "name": { "type": "string", "description": "The display name for Service Account", "example": "CI/CD api token" }, "systemRole": { "type": "string", "description": "The system role for Service Account", "example": "ROLE_SERVICE_ACCOUNT" }, "teamId": { "type": "integer", "description": "Team ID", "format": "int64", "example": 21 }, "teamRole": { "type": "string", "description": "The team role for Service Account. It can be string for predefined roles or id of a custom role", "example": "CICD_SCANNING" } }, "description": "Service Account response that contains API key" }, "ServiceAccountsResponseDto": { "type": "object", "properties": { "serviceAccounts": { "type": "array", "description": "List of Service Accounts found", "items": { "$ref": "#/components/schemas/ServiceAccountDto" } }, "total": { "type": "integer", "description": "Total number of Service Accounts available", "format": "int64", "example": 12 } }, "description": "Service Accounts list with count response definition" }, "SilencingRule": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "scope": { "type": "string" } }, "description": "Lists the silencing rules that matched this event" }, "SilencingRuleBulkRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "description": "List of IDs on which the bulk operation should operate", "items": { "type": "integer", "description": "List of IDs on which the bulk operation should operate", "format": "int64" } } }, "description": "Bulk request object" }, "SilencingRuleBulkRequestWrapper": { "required": [ "silencingRules" ], "type": "object", "properties": { "silencingRules": { "$ref": "#/components/schemas/SilencingRuleBulkRequest" } }, "description": "Bulk request wrapper object" }, "SilencingRuleDTO": { "required": [ "durationInSec", "enabled", "name", "startTs" ], "type": "object", "properties": { "alertIds": { "maxItems": 10, "minItems": 0, "uniqueItems": true, "type": "array", "description": "IDs of alerts to be silenced", "items": { "type": "integer", "description": "IDs of alerts to be silenced", "format": "int64" } }, "createdOn": { "type": "integer", "description": "Creation date in milliseconds", "format": "int64", "readOnly": true }, "durationInSec": { "type": "integer", "description": "Duration of the rule in seconds. Max duration is 365 days", "format": "int64" }, "enabled": { "type": "boolean", "description": "Boolean to set the rule enabled or not" }, "id": { "type": "integer", "description": "Unique ID. Must be set to null when creating a new silencing rule", "format": "int64" }, "modifiedOn": { "type": "integer", "description": "Last modification date in milliseconds", "format": "int64", "readOnly": true }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name of the rule" }, "notificationChannelIds": { "uniqueItems": true, "type": "array", "description": "List of channels IDs the rule should notify the start and end of silencing", "items": { "type": "integer", "description": "List of channels IDs the rule should notify the start and end of silencing", "format": "int64" } }, "scope": { "type": "string", "description": "Scope of the rule, expressed as a string", "example": "kubernetes_cluster_name = 'foo'" }, "startTs": { "type": "integer", "description": "Start time of the rule in milliseconds", "format": "int64" }, "version": { "type": "integer", "description": "Object version. Must be set to null when creating a new silencing rule", "format": "int64" } }, "description": "Silencing rule definition" }, "SilencingRuleResponseWrapper": { "required": [ "silencingRules" ], "type": "object", "properties": { "silencingRules": { "type": "array", "items": { "$ref": "#/components/schemas/SilencingRuleDTO" } } }, "description": "Response wrapper object" }, "SummaryComparableDataWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "metrics", "showAs" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ComparableDataWidget" }, { "type": "object", "properties": { "colorCoding": { "$ref": "#/components/schemas/ColorCoding" } } }, { "$ref": "#/components/schemas/DashboardWidget" } ] }, "TeamMapDto": { "required": [ "allTeams", "teamIds" ], "type": "object", "properties": { "allTeams": { "type": "boolean", "description": "Boolean showing whether TeamMap should resemble all customer teams" }, "teamIds": { "uniqueItems": true, "type": "array", "description": "Set of team IDs, is empty when allTeams is true, otherwise needs at least 1 element", "example": [ 154, 187 ], "items": { "type": "integer", "description": "Set of team IDs, is empty when allTeams is true, otherwise needs at least 1 element", "format": "int64" } } } }, "TeamServiceAccountCreateDto": { "required": [ "name", "systemRole", "teamId", "teamRole" ], "type": "object", "properties": { "expirationDate": { "type": "integer", "description": "[Optional] - Time when the Service Account API key expires, in number of milliseconds since January 1, 1970, 00:00:00 GMT", "format": "int64", "example": 1630326638135 }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "The display name for Service Account", "example": "CI/CD api token" }, "systemRole": { "pattern": "ROLE_SERVICE_ACCOUNT|ROLE_RUNTIME_INSIGHTS", "type": "string", "description": "The system role for Service Account", "example": "ROLE_SERVICE_ACCOUNT" }, "teamId": { "type": "integer", "description": "Team ID", "format": "int64", "example": 21 }, "teamRole": { "type": "string", "description": "The team role for Service Account. It can be string for predefined roles or id of a custom role", "example": "CICD_SCANNING" } }, "description": "Service Account body used for creation" }, "TemplateConfiguration": { "type": "object", "properties": { "templateConfigurationSections": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateConfigurationSection" } }, "templateKey": { "type": "string", "enum": [ "EMAIL_MONITOR_ALERT_NOTIFICATION_TEMPLATE_METADATA_v1", "SLACK_MONITOR_ALERT_NOTIFICATION_TEMPLATE_METADATA_v1", "SNS_MONITOR_ALERT_NOTIFICATION_TEMPLATE_METADATA_v1", "SLACK_SECURE_EVENT_NOTIFICATION_TEMPLATE_METADATA_v1", "SLACK_SECURE_EVENT_NOTIFICATION_TEMPLATE_METADATA_v2", "MS_TEAMS_SECURE_EVENT_NOTIFICATION_TEMPLATE_METADATA_v1", "MS_TEAMS_SECURE_EVENT_NOTIFICATION_TEMPLATE_METADATA_v2" ] } } }, "TemplateConfigurationDTO": { "type": "object", "properties": { "templateConfigurationSections": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateConfigurationSectionDTO" } }, "templateKey": { "type": "string" } } }, "TemplateConfigurationSection": { "type": "object", "properties": { "sectionName": { "type": "string", "enum": [ "MONITOR_ALERT_NOTIFICATION_HEADER", "MONITOR_ALERT_NOTIFICATION_CHART", "MONITOR_ALERT_NOTIFICATION_DASHBOARD_LINKS", "MONITOR_ALERT_NOTIFICATION_RUNBOOK_LINKS", "MONITOR_ALERT_NOTIFICATION_USER_DEFINED_CONTENT", "MONITOR_ALERT_NOTIFICATION_EVENT_DETAILS", "MONITOR_ALERT_NOTIFICATION_ALERT_DETAILS", "MONITOR_ALERT_NOTIFICATION_CAPTURING_INFORMATION", "SECURE_EVENT_NOTIFICATION_CONTENT" ] }, "shouldShow": { "type": "boolean" } } }, "TemplateConfigurationSectionDTO": { "type": "object", "properties": { "sectionName": { "type": "string" }, "shouldShow": { "type": "boolean" } } }, "TextWidget": { "required": [ "customDisplayOptions", "gridConfiguration", "markdownSource", "showAs" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/DashboardWidget" }, { "type": "object", "properties": { "markdownSource": { "type": "string" }, "transparentBackground": { "type": "boolean" }, "panelTitleVisible": { "type": "boolean" }, "textAutosized": { "type": "boolean" }, "hasTransparentBackground": { "type": "boolean", "writeOnly": true } } } ] }, "Threshold": { "required": [ "best", "worst" ], "type": "object", "properties": { "best": { "type": "number" }, "worst": { "type": "number" } } }, "ValueLimit": { "type": "object", "properties": { "count": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32" }, "direction": { "type": "string", "enum": [ "desc", "asc" ] } } }, "WidgetConverterRequest": { "required": [ "widgets" ], "type": "object", "properties": { "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" } } } }, "WidgetConverterResponse": { "required": [ "panels" ], "type": "object", "properties": { "panels": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3Panel" } } } }, "WidgetMetric": { "required": [ "id", "propertyName" ], "type": "object", "properties": { "groupAggregation": { "type": "string", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] }, "id": { "type": "string" }, "metricFormattingDecimals": { "maximum": 4, "minimum": 0, "type": "integer", "format": "int32" }, "metricFormattingUnit": { "type": "string" }, "propertyName": { "type": "string" }, "timeAggregation": { "type": "string", "enum": [ "avg", "timeAvg", "max", "min", "sum", "key", "none", "concat", "count", "distinct", "delta", "percentile50", "percentile75", "percentile90", "percentile95", "percentile99", "rateOfChange", "counter" ] } } }, "AccessKeyResponseV1": { "description": "Access key response", "properties": { "accessKey": { "description": "Displays the access key value", "example": "f97af7c5-dac3-49b1-b5e0-710871d34a15", "maxLength": 256, "type": "string" }, "agentLimit": { "description": "Maximum number of agents that can be connected with the access key", "example": 100, "format": "int32", "maximum": 2147483647, "minimum": 0, "nullable": true, "type": "integer" }, "agentReservation": { "description": "Number of agents that are guaranteed to be available for the access key", "example": 5, "format": "int32", "maximum": 2147483647, "minimum": 0, "nullable": true, "type": "integer" }, "dateCreated": { "description": "Date and time when access key was created\n", "example": "2022-01-31T22:15:28Z", "format": "date-time", "maxLength": 64, "nullable": true, "type": "string" }, "dateDisabled": { "description": "Date and time when access key was disabled\n", "example": "2022-01-31T22:15:28Z", "format": "date-time", "maxLength": 64, "nullable": true, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "isEnabled": { "description": "Indicates if the access key is enabled", "example": true, "type": "boolean" }, "metadata": { "additionalProperties": { "example": "metaKey1:metaValue1", "maxLength": 76, "type": "string" }, "description": "Access key metadata (maximum of 20 key-value pairs where key can be up to 25 characters long and value can be up to 50 characters long)", "maxItems": 20, "type": "object" }, "teamId": { "description": "ID of team that owns the access key", "example": 13, "format": "int32", "maximum": 2147483647, "minimum": 0, "nullable": true, "type": "integer" } }, "title": "Access Key Response V1", "type": "object" }, "AdditionalTeamPermissionsV1": { "description": "Additional permissions available to the users of the team.", "properties": { "hasAgentCli": { "default": false, "example": false, "type": "boolean" }, "hasAwsData": { "default": false, "example": false, "type": "boolean" }, "hasBeaconMetrics": { "default": false, "example": false, "type": "boolean" }, "hasInfrastructureEvents": { "default": false, "example": false, "type": "boolean" }, "hasRapidResponse": { "default": false, "example": false, "type": "boolean" }, "hasSysdigCaptures": { "default": false, "description": "Enable the Sysdig captures feature for this team.", "example": false, "type": "boolean" } }, "title": "Additional Team Permissions", "type": "object" }, "AllSsoSettingsResponseV1": { "properties": { "data": { "description": "The list of SSO settings.", "items": { "$ref": "#/components/schemas/SsoSettingsResponseV1" }, "maxItems": 250, "type": "array" } }, "title": "Get All SSO Settings Response V1", "type": "object" }, "AuditEvent": { "description": "Platform Audit Event", "properties": { "content": { "$ref": "#/components/schemas/AuditTrailContent" }, "cursor": { "description": "The cursor that can be used to fetch a set of events surrounding\nthis same event. By providing this value as `cursor` in a GET\nrequest, you will get the set of events surrounding\nthis current event.\n", "example": "LTltNGUybXIwdWkzZThhMjE1bjRn", "maxLength": 64, "type": "string" }, "id": { "description": "The event id.", "example": "15cbf54e34df95404caad1c988cf7c42", "maxLength": 32, "type": "string" }, "labels": { "additionalProperties": { "example": "entityType:auth", "maxLength": 256, "type": "string" }, "description": "Key value pairs of values, represents entityType where the Audit Event was generated.\n", "example": { "entityType": "auth" }, "type": "object" }, "timestamp": { "description": "The event timestamp in nanoseconds.", "example": 1617220000000000000, "format": "int64", "maximum": 9223372036854776000, "minimum": 0, "type": "integer" } } }, "AuditTrailContent": { "description": "Content object for Platform Audit Event.", "properties": { "entityId": { "description": "ID of the entity that was affected by the action.", "example": "", "maxLength": 64, "type": "string" }, "entityPayload": { "description": "Payload of the entity that was affected by the action.", "example": "SAMLResponse=***&RelayState=%23%2F%26customer%3D5", "maxLength": 1024, "type": "string" }, "entityType": { "description": "Type of entity that was affected by the action. Full list of possible values can be found in the our documentation\nhttps://docs.sysdig.com/en/docs/administration/administration-settings/app-status-and-audit/sysdig-platform-audit/#sysdig-monitor-and-sysdig-platform.\n", "example": "policy", "maxLength": 64, "type": "string" }, "queryString": { "description": "Query string of the request that was used to preform action.", "example": "controlId=1&resourceKind=workload", "maxLength": 8192, "type": "string" }, "requestMethod": { "description": "HTTP request method that was used to preform action.", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ], "example": "GET", "type": "string" }, "requestUri": { "description": "URI of the request that was used to preform action.", "example": "/api/v1/audit", "maxLength": 4096, "type": "string" }, "responseStatusCode": { "description": "HTTP response status code of the request that was used to preform action.", "example": 200, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "serviceAccountId": { "description": "ID of the service account that was used to preform action.", "example": 123, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "serviceAccountName": { "description": "Name of the service account that was used to preform action.", "example": "service-account-1", "maxLength": 256, "type": "string" }, "teamId": { "description": "Team ID, that user who preformed some action was logged in.", "example": 13, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "teamName": { "description": "Name of the team, that user who preformed action was logged in.", "example": "Security Operations", "maxLength": 256, "type": "string" }, "timestampNs": { "description": "The event timestamp in nanoseconds.", "example": 1617220000000000000, "format": "int64", "maximum": 9223372036854776000, "minimum": 0, "type": "integer" }, "userId": { "description": "ID of user that was preforming some action.", "example": 122, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "userOriginIP": { "description": "IP address of the user that was preforming action.", "example": "22.220.145.219", "format": "ipv4 or ipv6", "maxLength": 43, "type": "string" }, "username": { "description": "Username of the user that was preforming some action.", "example": "joendoe", "maxLength": 64, "type": "string" } } }, "BucketConfigurationV1": { "properties": { "description": { "description": "The description of the bucket.", "example": "My bucket description", "maxLength": 255, "nullable": true, "type": "string" }, "endpoint": { "description": "The endpoint of the bucket. ***Required for S3 compatible storage.***", "example": "https://my-bucket.s3.amazonaws.com", "maxLength": 255, "nullable": true, "type": "string" }, "folder": { "description": "The folder in the bucket where the captures are stored. Name of the folder without any prefix slashes (\"test-folder\" and not \"/test-folder\").", "example": "my-folder", "maxLength": 255, "type": "string" }, "name": { "description": "The name of the bucket.", "example": "my-bucket", "maxLength": 255, "type": "string" }, "pathStyleAccess": { "default": false, "description": "Specifies if the bucket uses path-style access.", "example": false, "type": "boolean" }, "providerKeyId": { "description": "Id of the configured cloud provider account. Could be fetched with /api/providers endpoint.", "example": "my-provider-key-id", "maxLength": 255, "nullable": true, "type": "string" }, "region": { "description": "The region of the bucket.", "example": "us-east-1", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "name" ], "title": "Bucket Configuration V1", "type": "object" }, "CaptureStorageConfigurationResponseV1": { "properties": { "buckets": { "description": "The list of buckets where the captures are stored. Currently only one bucket is supported.\n", "items": { "$ref": "#/components/schemas/BucketConfigurationV1" }, "maxItems": 1, "nullable": true, "type": "array" }, "isEnabled": { "description": "Specifies if capture storage is enabled.", "example": false, "type": "boolean" }, "isEncryptionWithProvidedKeyEnabled": { "description": "Specifies if server-side encryption with provided encryption key (SSE-C) is enabled.", "example": false, "type": "boolean" } }, "title": "Capture Storage Configuration Response V1", "type": "object" }, "CreateAccessKeyRequestV1": { "description": "Create access key request", "properties": { "agentLimit": { "description": "Maximum number of agents that can be connected with the access key", "example": 100, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "agentReservation": { "description": "Number of agents that are guaranteed to be available for the access key", "example": 5, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "metadata": { "additionalProperties": { "example": "metaKey1:metaValue1", "maxLength": 76, "type": "string" }, "description": "Access key metadata (maximum of 20 key-value pairs where key can be up to 25 characters long and value can be up to 50 characters long)", "maxItems": 20, "type": "object" }, "teamId": { "description": "ID of team that owns the access key", "example": 13, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "title": "Create Access Key Request", "type": "object" }, "CreateGlobalServiceAccountRequestV1": { "allOf": [ { "$ref": "#/components/schemas/CreateServiceAccountRequestV1" }, { "properties": { "systemRoles": { "description": "Array of System roles assigned to the global service account.", "items": { "example": "ROLE_SERVICE_ACCOUNT", "maxLength": 128, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" } ], "required": [ "name", "systemRoles" ], "title": "Create Global Service Account Request V1", "type": "object" }, "CreateGroupMappingRequestV1": { "properties": { "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role ID assigned for the user in this team. **Mutually exclusive with standardTeamRole**.\n", "nullable": true }, "groupName": { "description": "The group name matching the external provider name.", "example": "Admins_Mapped_Group", "maxLength": 256, "type": "string" }, "isAdmin": { "description": "Flag that indicates if the group is an admin group.", "example": false, "type": "boolean" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned for the user in this team. **Mutually exclusive with customTeamRoleId**.\n", "nullable": true }, "teamMap": { "$ref": "#/components/schemas/TeamMapV1" }, "weight": { "default": 32767, "description": "The weight of the group mapping is used to determine the priority - a lower number has higher priority.", "example": 2, "format": "int16", "maximum": 32767, "minimum": 1, "type": "integer" } }, "required": [ "groupName", "teamMap" ], "title": "Create Group Mapping Request V1", "type": "object" }, "CreateInhibitionRuleRequestV1": { "properties": { "description": { "description": "Description of the inhibition rule.", "example": "this is an example description", "maxLength": 8192, "nullable": true, "type": "string" }, "equal": { "description": "List of labels that must have an equal value in the source and target alert for the inhibition to take effect.", "items": { "description": "Name of a label.", "example": "myLabel", "maxLength": 1024, "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "nullable": true, "type": "array" }, "isEnabled": { "default": true, "description": "Indicates if the inhibition rule is enabled or not.", "example": false, "type": "boolean" }, "name": { "description": "Name of the inhibition rule. If provided, must be unique.", "example": "this is an example name", "maxLength": 255, "nullable": true, "type": "string" }, "sourceMatchers": { "description": "List of source matchers for which one or more alerts have to exist for the inhibition to take effect.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" }, "targetMatchers": { "description": "List of target matchers that have to be fulfilled by the target alerts to be muted.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "sourceMatchers", "targetMatchers" ], "title": "Create Inhibition Rule Request v1" }, "CreateIpFilterV1": { "description": "Request to create IP filter.", "properties": { "ipRange": { "description": "IP range in CIDR notation", "example": "192.168.0.0/24", "maxLength": 43, "type": "string" }, "isEnabled": { "example": true, "type": "boolean" }, "note": { "example": "London Office", "maxLength": 128, "type": "string" } }, "required": [ "ipRange", "isEnabled" ], "title": "Create IP Filter Request V1", "type": "object" }, "CreatePricingRequestV1": { "properties": { "clusterName": { "description": "The name of the cluster. Required when `type` is `CLUSTER`.", "example": "My pricing", "maxLength": 256, "nullable": true, "type": "string" }, "name": { "description": "The name of the pricing configuration.", "example": "My pricing", "maxLength": 256, "type": "string" }, "spotLabel": { "description": "The name of a node label that is used to identify the node as a spot node.", "example": "cost-advisor-spot-node", "maxLength": 256, "nullable": true, "type": "string" }, "spotLabelValue": { "description": "The value of the spot node label.", "example": "true", "maxLength": 256, "nullable": true, "type": "string" }, "type": { "$ref": "#/components/schemas/PricingType" }, "unitPricing": { "allOf": [ { "$ref": "#/components/schemas/UnitPricingV1" } ], "description": "The unit pricing configuration used to compute costs." } }, "required": [ "type", "name", "unitPricing" ], "title": "Create Pricing Request", "type": "object" }, "CreateServiceAccountRequestV1": { "properties": { "expirationDate": { "description": "Time when the Service Account API key expires, | in number of milliseconds since January 1, 1970, 00:00:00 GMT", "example": 1630326638135, "format": "int64", "maximum": 9223372036854775000, "minimum": 0, "type": "integer" }, "name": { "description": "The display name of the Service Account.", "example": "CI/CD service api key", "maxLength": 256, "type": "string" } }, "title": "Create Service Account Request V1", "type": "object" }, "CreateServiceAccountsNotificationSettingsRequestV1": { "allOf": [ { "$ref": "#/components/schemas/ServiceAccountsNotificationSettinsBase" } ], "required": [ "isEnabled", "notificationChannelIds" ], "title": "Create Service Accounts Notification Settings Request V1", "type": "object" }, "CreateSsoSettingsRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsBaseSchemaV1" }, { "properties": { "config": { "$ref": "#/components/schemas/SsoSettingsCreateRequestBaseV1" } }, "type": "object" } ], "required": [ "product", "config" ], "title": "Create SSO settings Request V1", "type": "object" }, "CreateTeamRequestV1": { "properties": { "additionalTeamPermissions": { "$ref": "#/components/schemas/AdditionalTeamPermissionsV1" }, "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role assigned by default to users added to this team. **Mutually exclusive with standardTeamRoleId**.\n" }, "description": { "description": "A longer description of the team explaining what is it used for.", "example": "Longer team description", "maxLength": 2048, "type": "string" }, "isAllZones": { "description": "**True** if the users that are members of this team have access to all zones. **Mutually exclusive with zoneIds**.\\\n\\\n_Only supported in Secure features._\n", "example": false, "type": "boolean" }, "isDefaultTeam": { "description": "Specifies if the team is the default team. The default team is used to automatically assign new users to a team.", "example": false, "type": "boolean" }, "name": { "description": "The name of the team. It must be unique.", "example": "Team name", "maxLength": 256, "minLength": 1, "type": "string" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ], "description": "The product to which the team is assigned to. Teams can only be part of a single product at a time." }, "scopes": { "description": "Scopes is a list of different scope types and filter values that will be applied to resources\nwhen accessed through the team.\n", "items": { "$ref": "#/components/schemas/ScopeV1" }, "maxItems": 512, "type": "array" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned by default to users added to this team. **Mutually exclusive with customTeamRoleId**.\\\n\\\n*ROLE_TEAM_SERVICE_MANAGER is only supported in Secure.*\n" }, "uiSettings": { "$ref": "#/components/schemas/UiSettingsV1" }, "zoneIds": { "description": "The list of zones that users assigned to this team will have access to. **Mutually exclusive with allZones**.\\\n\\\n_Only supported in Secure features._\n", "items": { "$ref": "#/components/schemas/UnlimitedLong" }, "maxItems": 8192, "type": "array" } }, "required": [ "name", "product" ], "title": "Create Team Request", "type": "object" }, "CreateTeamServiceAccountRequestV1": { "allOf": [ { "$ref": "#/components/schemas/CreateServiceAccountRequestV1" }, { "properties": { "teamRole": { "description": "Team role to be assigned to the team service account. | It can be a string for predefined roles or an id of a custom role.", "example": "CICD_SCANNING", "maxLength": 128, "type": "string" } }, "type": "object" } ], "required": [ "name", "teamRole" ], "title": "Create Team Service Account Request V1", "type": "object" }, "CreateUserRequestV1": { "description": "Request to create the User", "properties": { "email": { "description": "The email address of the user. If the activation flow is set, this address will\nbe used to send the activation email.\n", "example": "john.doe@nomail.cc", "format": "email", "maxLength": 512, "type": "string" }, "firstName": { "description": "The name of the user.\n", "example": "John", "maxLength": 256, "type": "string" }, "isAdmin": { "default": false, "description": "**True** if the user has Administration permissions.\n", "example": false, "type": "boolean" }, "lastName": { "description": "The surname of the user.\n", "example": "Doe", "maxLength": 256, "type": "string" }, "products": { "description": "The user will be added to the default teams specified by this field.", "example": [ "secure", "monitor" ], "items": { "$ref": "#/components/schemas/Product" }, "maxItems": 2, "type": "array" } }, "required": [ "email" ], "title": "Create User Request V1", "type": "object" }, "Cursor": { "description": "Cursor is a string used to retrieve paginated data. It acts as a pointer to the next page of data. When a cursor is defined, the `from` and `to` parameters must not be used.\n", "example": "LTltNGUybXIwdWkzZThhMjE1bjRn", "maxLength": 512, "type": "string" }, "DaysInYearInt": { "description": "Number of days in a year", "example": 90, "format": "int32", "maximum": 365, "minimum": 1, "type": "integer" }, "DisableJobsAndMetricsV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "jobName": { "description": "The Prometheus Job for which the collection of one or more metrics is disabled.\n", "example": "k8s-pods", "maxLength": 256, "type": "string" }, "metrics": { "description": "List of metrics to be disabled.\n", "items": { "$ref": "#/components/schemas/DisableMetricV1" }, "maxItems": 1000, "type": "array" } }, "type": "object" }, "DisableMetricV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "isDisabled": { "description": "Set as `true` to disable a metric. \\\nSet as `false` to re-enable a metric.\n", "example": true, "type": "boolean" }, "metricName": { "description": "The name of the metric to be disabled/re-enabled.\n", "example": "apache_accesses_total", "maxLength": 256, "type": "string" } }, "type": "object" }, "EntryPointModuleV1": { "description": "The Module is the area in Sysdig Monitor.", "enum": [ "Alerts", "Dashboards", "Events", "Explore", "Overview", "Settings", "DashboardTemplates" ], "example": "Alerts", "title": "Entry Point Module", "type": "string" }, "EntryPointV1": { "description": "The page you see after logging into Sysdig UI. It is defined by a Module and a Selection.\n**The Entry Point is not supported in Sysdig Secure.**\n", "properties": { "module": { "$ref": "#/components/schemas/EntryPointModuleV1" }, "selection": { "description": "The selection is the specific page within the Module, usually defined by the resource ID.\nIt is supported only supported by **Dashboards** and **DashboardTemplates** Modules.\n", "example": "2231245", "maxLength": 128, "nullable": true, "type": "string" } }, "title": "Entry Point", "type": "object" }, "Error": { "properties": { "details": { "description": "A list of details related to the error.", "items": {}, "maxItems": 512, "type": "array" }, "message": { "description": "A human readable error message.", "example": "Error message", "maxLength": 8192, "type": "string" }, "type": { "description": "The error code.", "example": "resource_not_found", "maxLength": 512, "type": "string" } }, "title": "Error", "type": "object" }, "EventsFeedFilter": { "description": "Query language expression for filtering results.\nThe filter is the result of logical concatenations,\nusing \"and\" and \"or\" binary operators and the \"not\" unary prefix operator (i.e. `auditTrail.requestMethod = 'GET' and auditTrail.entityType = 'user'`),\nof attribute comparisons. Attribute comparisons can be:\n- scalar, using `=`, `!=` comparison operators (i.e. `auditTrail.teamName = 'Test team'`)\n", "example": "auditTrail.requestMethod = 'GET' and auditTrail.entityType = 'user'", "maxLength": 2048, "type": "string" }, "EventsFeedLimit": { "default": 100, "description": "The number of items to return", "example": 50, "format": "int32", "maximum": 999, "minimum": 1, "type": "integer" }, "From": { "description": "From, expressed in Unix nanoseconds timestamp. The difference between `from` and `to`\ncannot be greater than 2 weeks.\nIf defined, `cursor` cannot be used.\n", "example": 1546300800000000000, "format": "int64", "maximum": 9223372036854776000, "minimum": 0, "type": "integer" }, "GetAccessKeysPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/AccessKeyResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Access Keys Response V1" }, "GetInhibitionRulesPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/InhibitionRuleResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Inhibition Rules Response v1" }, "GetPermissionsResponseV1": { "description": "Permissions response", "properties": { "permissions": { "description": "Set of permissions\n", "items": { "$ref": "#/components/schemas/PermissionV1" }, "maxItems": 1000, "type": "array", "uniqueItems": true }, "total": { "description": "Total number of permissions", "example": 135, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "title": "Permissions Response V1", "type": "object" }, "GetPricingPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PricingResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Pricing Response V1" }, "GetPricingProjectedPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/PricingProjectedResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Pricing Projected Response V1" }, "GetRolesPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/RoleResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Roles Response V1" }, "GetServiceAccountsPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/ServiceAccountResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Service Accounts Paginated Response V1" }, "GetTeamUsersPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/TeamUserResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Team Users Response V1" }, "GetTeamsPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/TeamResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Teams Response V1" }, "GetUsersPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/UserResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated Users Response V1" }, "GroupMappingResponseV1": { "properties": { "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role ID assigned for the user in this team. **Mutually exclusive with standardTeamRole**.\n", "nullable": true }, "dateCreated": { "description": "The date in which this group mapping was created in ISO 8601 format.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "groupName": { "description": "The group name matching the external provider name.", "example": "Admins_Mapped_Group", "maxLength": 256, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "isAdmin": { "description": "Flag that indicates if the group is an admin group.", "example": false, "type": "boolean" }, "lastUpdated": { "description": "The date in which this group mapping was last updated in ISO 8601 format.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned for the user in this team. **Mutually exclusive with customTeamRoleId**.\n", "nullable": true }, "teamMap": { "$ref": "#/components/schemas/TeamMapV1" }, "weight": { "description": "The weight of the group mapping that is used to determine the priority - a lower number has higher priority.", "example": 2, "format": "int16", "maximum": 32767, "minimum": 1, "type": "integer" } }, "title": "Group Mapping Response V1", "type": "object" }, "GroupMappingSettingsV1": { "description": "The request to save group mapping settings.\nCurrently settings for conflict resolution strategies are supported.\n", "properties": { "differentRolesSameTeamStrategy": { "description": "Strategy for handling different roles on the same team.\n", "enum": [ "UNAUTHORIZED", "FIRST_MATCH", "WEIGHTED" ], "example": "UNAUTHORIZED", "type": "string" }, "noMappingStrategy": { "description": "Strategy for handling no mappings.\n", "enum": [ "UNAUTHORIZED", "DEFAULT_TEAM_DEFAULT_ROLE", "NO_MAPPINGS_ERROR_REDIRECT" ], "example": "UNAUTHORIZED", "type": "string" }, "noMappingsErrorRedirectUrl": { "description": "Redirect URL when NO_MAPPINGS_ERROR_REDIRECT is selected.\n", "example": "https://www.example.com", "maxLength": 2048, "nullable": true, "type": "string" } }, "required": [ "noMappingStrategy", "differentRolesSameTeamStrategy" ], "title": "Group Mapping Settings Request V1", "type": "object" }, "GroupMappingsPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/GroupMappingResponseV1" }, "maxItems": 8192, "type": "array" } }, "type": "object" } ], "title": "Get Group Mappings Paginated Response V1" }, "InhibitionRuleResponseV1": { "properties": { "createdOn": { "description": "Creation date.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "customerId": { "description": "ID of customer that owns the inhibition rule.", "example": 12, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "description": { "description": "Description of the inhibition rule.", "example": "this is an example description", "maxLength": 8192, "nullable": true, "type": "string" }, "equal": { "description": "List of labels that must have an equal value in the source and target alert for the inhibition to take effect.", "items": { "description": "Name of a label.", "example": "myLabel", "maxLength": 1024, "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "nullable": true, "type": "array" }, "id": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "Unique ID of the resource." }, "isEnabled": { "default": true, "description": "Indicates if the inhibition rule is enabled or not.", "example": false, "type": "boolean" }, "modifiedOn": { "description": "Last modification date.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "name": { "description": "Name of the inhibition rule.", "example": "this is an example name", "maxLength": 255, "nullable": true, "type": "string" }, "sourceMatchers": { "description": "List of source matchers for which one or more alerts have to exist for the inhibition to take effect.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" }, "targetMatchers": { "description": "List of target matchers that have to be fulfilled by the target alerts to be muted.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" }, "teamId": { "description": "ID of team that owns the inhibition rule.", "example": 13, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource." } }, "title": "Inhibition Rule Response v1" }, "IpFilterResponseV1": { "properties": { "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "ipRange": { "description": "IP range in CIDR notation", "example": "192.168.0.0/24", "maxLength": 43, "type": "string" }, "isAllowed": { "description": "Whether the IP range is allowed or not.", "example": true, "type": "boolean" }, "isEnabled": { "example": true, "type": "boolean" }, "lastUpdated": { "description": "The date when IP filter was last updated.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "note": { "example": "London Office", "maxLength": 128, "nullable": true, "type": "string" } }, "title": "IP Filter Response V1", "type": "object" }, "IpFiltersPaginatedResponseV1": { "allOf": [ { "$ref": "#/components/schemas/OffsetPaginatedResponse" }, { "properties": { "data": { "items": { "$ref": "#/components/schemas/IpFilterResponseV1" }, "maxItems": 200, "type": "array" } }, "type": "object" } ], "title": "Get Paginated IP Filters Response V1" }, "IpFiltersSettingsV1": { "description": "Used to configure IP filters settings.\n", "properties": { "isFilteringEnabled": { "description": "Specifies if IP filtering is enabled.", "example": false, "type": "boolean" } }, "title": "Ip Filters Settings V1", "type": "object" }, "LabelMatcherV1": { "description": "Matcher to match alerts to inhibition rules.", "properties": { "labelName": { "description": "Label to match.", "example": "myLabel", "maxLength": 1024, "minLength": 1, "type": "string" }, "operator": { "description": "Match operator.", "enum": [ "EQUALS", "NOT_EQUALS", "REGEXP_MATCHES", "NOT_REGEXP_MATCHES" ], "example": "EQUALS", "type": "string" }, "value": { "description": "Label value to match in case operator is of type equality, or regular expression in case of operator is of type regex.", "example": "regexExample[s]?", "maxLength": 1024, "minLength": 0, "type": "string" } }, "required": [ "labelName", "operator", "value" ], "title": "Label matcher v1", "type": "object" }, "ListAuditEventsResponse": { "description": "The list of events matching a search criteria.", "properties": { "data": { "description": "The list of Audit events.", "items": { "$ref": "#/components/schemas/AuditEvent" }, "maxItems": 999, "type": "array" }, "page": { "$ref": "#/components/schemas/Page" } }, "required": [ "page", "data" ], "type": "object" }, "ListJobAndDisabledMetricsV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "jobName": { "description": "The name of the Job reporting the metric.\n", "example": "k8s-pods", "maxLength": 256, "type": "string" }, "metrics": { "description": "List of metrics which are disabled for the Job.\n", "items": { "$ref": "#/components/schemas/MetricV1" }, "maxItems": 1000, "type": "array" } }, "type": "object" }, "MetricErrorV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "jobName": { "description": "Denotes the name of the job which the error was caused.\n", "example": "k8s-pods", "maxLength": 256, "type": "string" }, "message": { "description": "Error explanation for the job and metric.\n", "example": "This is not a valid metric name.", "maxLength": 256, "type": "string" }, "metricName": { "description": "The metric name which could not be disabled/enabled\n", "example": "apache_accesses_total", "maxLength": 256, "type": "string" } }, "type": "object" }, "MetricV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "metricName": { "description": "Denotes the name of the disabled metric.\n", "example": "apache_accesses_total", "maxLength": 256, "type": "string" }, "modifiedDate": { "description": "The timestamp the metric was disabled\n", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "userId": { "description": "UserId responsible for disabling the metric\n", "example": 1234, "format": "int64", "maximum": 99999999999999, "minimum": 0, "type": "integer" }, "userName": { "description": "User name which has disabled the metric\n", "example": "John Smith", "maxLength": 256, "type": "string" } }, "type": "object" }, "OffsetPaginatedResponse": { "properties": { "data": { "description": "Paginated data.", "items": {}, "maxItems": 200, "type": "array" }, "page": { "description": "Page information.", "properties": { "next": { "example": "30", "maxLength": 8192, "nullable": true, "type": "string" }, "previous": { "example": "10", "maxLength": 8192, "nullable": true, "type": "string" }, "total": { "example": 1, "format": "int64", "minimum": 0, "type": "integer" } }, "type": "object" } }, "title": "Offset Paginated Response", "type": "object" }, "OpenIdBaseV1": { "properties": { "additionalScopes": { "description": "List of additional scopes to be verified on login.", "example": [ "scope 1", "scope 2" ], "items": { "description": "The scope to be verified on login.", "example": "scope 1", "maxLength": 64, "type": "string" }, "maxItems": 64, "type": "array" }, "clientId": { "description": "The client ID of the OpenID Connect provider.", "example": "client-id", "maxLength": 2048, "type": "string" }, "groupAttributeName": { "description": "The group attribute name of the OpenID Connect provider.", "example": "groups", "maxLength": 64, "type": "string" }, "isAdditionalScopesCheckEnabled": { "description": "Flag to indicate if the additional scopes verification on login.", "example": true, "type": "boolean" }, "isMetadataDiscoveryEnabled": { "description": "Flag to indicate if the metadata discovery is enabled.", "example": true, "type": "boolean" }, "issuerUrl": { "description": "The issuer URL of the OpenID Connect provider.", "example": "https://accounts.example.com", "maxLength": 2048, "type": "string" }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/OpenIdMetadataV1" } ], "description": "The metadata of the OpenID Connect provider." } }, "title": "OpenID Settings Base Schema", "type": "object" }, "OpenIdConfigResponseV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsResponseBaseV1" }, { "$ref": "#/components/schemas/OpenIdBaseV1" } ], "title": "OpenID Connect SSO Settings Response V1", "type": "object" }, "OpenIdCreateRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsCreateRequestBaseV1" }, { "$ref": "#/components/schemas/OpenIdRequestBaseV1" } ], "required": [ "issuerUrl", "clientId", "clientSecret" ], "title": "OpenID Connect SSO Settings Create Request V1", "type": "object" }, "OpenIdMetadataV1": { "properties": { "authorizationEndpoint": { "description": "The authorization endpoint of the OpenID Connect provider.", "example": "https://accounts.example.com/oauth2/authorize", "maxLength": 2048, "type": "string" }, "endSessionEndpoint": { "description": "Single sign-out endpoint of the OpenID Connect provider.", "example": "https://accounts.example.com/oauth2/logout", "maxLength": 2048, "type": "string" }, "issuer": { "description": "The base issuer URL of the OpenID Connect provider.", "example": "https://accounts.example.com", "maxLength": 2048, "type": "string" }, "jwksUri": { "description": "The JSON Web Key Set URI of the OpenID Connect provider.", "example": "https://accounts.example.com/oauth2/jwks", "maxLength": 2048, "type": "string" }, "tokenAuthMethod": { "description": "The token authentication method of the OpenID Connect provider.", "enum": [ "CLIENT_SECRET_BASIC", "CLIENT_SECRET_POST" ], "example": "CLIENT_SECRET_BASIC", "type": "string" }, "tokenEndpoint": { "description": "The token endpoint of the OpenID Connect provider.", "example": "https://accounts.example.com/oauth2/token", "maxLength": 2048, "type": "string" } }, "required": [ "issuerBaseUrl", "authorizationEndpoint", "tokenEndpoint", "jsonWebKeySetEndpoint", "tokenAuthMethod" ], "title": "The metadata of the OpenID Connect provider", "type": "object" }, "OpenIdRequestBaseV1": { "allOf": [ { "$ref": "#/components/schemas/OpenIdBaseV1" }, { "properties": { "clientSecret": { "description": "The client secret of the OpenID Connect provider.", "example": "client-secret", "maxLength": 2048, "type": "string" } }, "type": "object" } ], "title": "OpenID Settings Base Write Request V1", "type": "object" }, "OpenIdUpdateRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsUpdateRequestBaseV1" }, { "$ref": "#/components/schemas/OpenIdRequestBaseV1" } ], "required": [ "issuerUrl", "clientId", "clientSecret", "isAdditionalScopesCheckEnabled", "isMetadataDiscoveryEnabled" ], "title": "OpenID Connect SSO Settings Update Request V1", "type": "object" }, "Page": { "description": "Pagination information.", "properties": { "next": { "description": "`next` is a string pointing to the next page of data.\nUse this as the `cursor` to scroll paginated results and get the next page of data. \nIf not included, the current response is the last page.\n", "example": "KzltNGUybXIwdWkzZThhMjE1bjRn", "maxLength": 512, "type": "string" }, "prev": { "description": "`prev` is a string pointing to the previous page of data.\nUse this as the `cursor` to get the previous page of data.\n", "example": "LTltNGUybXIwdWkzZThhMjE1bjRn", "maxLength": 512, "type": "string" }, "total": { "description": "The number of events matching the search criteria. This number is always major or equal to the number of events returned.\n", "example": 10, "format": "int64", "maximum": 9223372036854776000, "minimum": 0, "type": "integer" } }, "required": [ "total" ], "type": "object" }, "PermissionV1": { "description": "Permission to perform an action on the Sysdig platform.", "properties": { "dependencies": { "description": "List of permissions that this permission depends on.\n", "items": { "example": "cspm-results.read", "maxLength": 256, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true }, "description": { "description": "Permission description.\n", "example": "Access CSPM results", "maxLength": 512, "type": "string" }, "id": { "description": "Permission Authority.\n", "example": "cspm-results.read", "maxLength": 256, "type": "string" }, "products": { "description": "Specifies the Sysdig product the permission applies to (Secure = SDS; Monitor = SDC).\n", "items": { "description": "Sysdig Monitor Product - SDC\\\nSysdig Secure Product - SDS\n", "example": "SDS", "maxLength": 3, "type": "string" }, "maxItems": 2, "type": "array", "uniqueItems": true } }, "type": "object" }, "PricingProjectedResponseV1": { "description": "The montly projected cost for a specific cluster.", "properties": { "clusterName": { "description": "The name of the cluster.", "example": "My pricing", "maxLength": 256, "type": "string" }, "monthlyProjectedCost": { "description": "Monthly projected cost.", "example": 113114.72, "type": "number" } }, "title": "Pricing Projected Response V1", "type": "object" }, "PricingResponseV1": { "description": "The pricing configuration used to compute costs.", "properties": { "clusterName": { "description": "The name of the cluster. Required when `type` is `CLUSTER`.", "example": "My pricing", "maxLength": 256, "nullable": true, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "name": { "description": "The name of the pricing profile.", "example": "My pricing", "maxLength": 256, "type": "string" }, "spotLabel": { "description": "The name of a node label that is used to identify the node as a spot node.", "example": "cost-advisor-spot-node", "maxLength": 256, "nullable": true, "type": "string" }, "spotLabelValue": { "description": "The value of the spot node label.", "example": "true", "maxLength": 256, "nullable": true, "type": "string" }, "type": { "$ref": "#/components/schemas/PricingType" }, "unitPricing": { "allOf": [ { "$ref": "#/components/schemas/UnitPricingV1" } ], "description": "The unit pricing configuration used to compute costs." }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource.\n" } }, "title": "Pricing Response V1", "type": "object" }, "PricingType": { "description": "The type of the pricing.", "enum": [ "DEFAULT", "CLUSTER" ], "example": "CLUSTER", "title": "Pricing type", "type": "string" }, "Product": { "description": "The Sysdig product", "enum": [ "monitor", "secure" ], "example": "secure", "title": "Sysdig Product", "type": "string" }, "RequestBodyDisabledMetricsV1": { "description": "Change Disabled Metrics per JobName", "properties": { "data": { "items": { "$ref": "#/components/schemas/DisableJobsAndMetricsV1" }, "maxItems": 1000, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ResponseListDisabledMetricsAndErrorV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "data": { "items": { "$ref": "#/components/schemas/ListJobAndDisabledMetricsV1" }, "maxItems": 1000, "type": "array" }, "errors": { "items": { "$ref": "#/components/schemas/MetricErrorV1" }, "maxItems": 1000, "type": "array" } }, "required": [ "data", "errors" ], "type": "object" }, "ResponseListDisabledMetricsV1": { "description": "Get Disabled Metrics by Job name Response", "properties": { "data": { "items": { "$ref": "#/components/schemas/ListJobAndDisabledMetricsV1" }, "maxItems": 1000, "type": "array" }, "errors": { "items": { "$ref": "#/components/schemas/MetricErrorV1" }, "maxItems": 0, "type": "array" } }, "required": [ "data" ], "type": "object" }, "RoleRequestV1": { "description": "Create or update role request", "properties": { "description": { "description": "Describes the role", "example": "Enables access to Dashboards section", "maxLength": 255, "type": "string" }, "monitorPermissions": { "description": "Set of Monitor permissions assigned to the role. \nCheck GET /platform/v1/permissions to obtain the list of available values.\n", "items": { "example": "alerts.read", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true }, "name": { "description": "The display name of the role", "example": "Dashboard Viewer", "maxLength": 255, "type": "string" }, "securePermissions": { "description": "Set of Secure permissions assigned to the role. \nCheck GET /platform/v1/permissions to obtain the list of available values.\n", "items": { "example": "scanning.read", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true } }, "required": [ "name" ], "title": "Role Request", "type": "object" }, "RoleResponseV1": { "description": "Create role response", "properties": { "description": { "description": "Describes the role", "example": "Enables access to Dashboards section", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "monitorPermissions": { "description": "Set of Monitor permissions assigned to the role. \nCheck GET /platform/v1/permissions to obtain the list of available values.\n", "items": { "example": "alerts.read", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true }, "name": { "description": "The display name of the role", "example": "Dashboard Viewer", "maxLength": 255, "type": "string" }, "securePermissions": { "description": "Set of Secure permissions assigned to the role. \nCheck GET /platform/v1/permissions to obtain the list of available values.\n", "items": { "example": "scanning.read", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true } }, "title": "Create Role Response", "type": "object" }, "SamlBaseV1": { "properties": { "emailParameter": { "description": "The email parameter of the SAML provider.", "example": "email", "maxLength": 2048, "type": "string" }, "isDestinationVerificationEnabled": { "description": "Flag that indicates if the destination verification is enabled.", "example": true, "type": "boolean" }, "isEncryptionSupportEnabled": { "description": "Flag that indicates if the encryption support is enabled.", "example": true, "type": "boolean" }, "isSignatureValidationEnabled": { "description": "Flag that indicates if the signature validation is enabled.", "example": true, "type": "boolean" }, "isSignedAssertionEnabled": { "description": "Flag that indicates if the signed assertion is enabled.", "example": true, "type": "boolean" }, "metadataUrl": { "description": "The metadata URL of the SAML provider. **Mutually exclusive with metadata*", "example": "https://accounts.example.com/metadata", "maxLength": 2048, "type": "string" }, "metadataXml": { "description": "The metadata XML of the SAML provider. **Mutually exclusive with metadataUrl*", "example": "\n", "maxLength": 65356, "type": "string" } }, "title": "SAML SSO Settings Base Schema V1", "type": "object" }, "SamlCreateRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsCreateRequestBaseV1" }, { "$ref": "#/components/schemas/SamlBaseV1" } ], "required": [ "emailParameter" ], "title": "SAML Settings Create Request V1", "type": "object" }, "SamlResponseV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsResponseBaseV1" }, { "$ref": "#/components/schemas/SamlBaseV1" } ], "title": "SAML Settings Response V1", "type": "object" }, "SamlUpdateRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsUpdateRequestBaseV1" }, { "$ref": "#/components/schemas/SamlBaseV1" } ], "required": [ "emailParameter", "isSignatureValidationEnabled", "isSignedAssertionEnabled", "isDestinationVerificationEnabled", "isEncryptionSupportEnabled" ], "title": "SAML Settings Update Request V1", "type": "object" }, "SaveCaptureStorageConfigurationRequestV1": { "properties": { "buckets": { "description": "The list of buckets where the captures are stored. Currently only one bucket is supported.\n", "items": { "$ref": "#/components/schemas/BucketConfigurationV1" }, "maxItems": 1, "type": "array" }, "encryptionKey": { "description": "AES-256 encryption key to be used for server-side encryption (base64 encoded).", "example": "23kA/KCxPktKXLijIIt91uB+sJ652w/ES9hZ3+eWadM=", "maxLength": 255, "type": "string" }, "isEnabled": { "description": "Specifies if capture storage is enabled.", "example": false, "type": "boolean" }, "isEncryptionWithProvidedKeyEnabled": { "default": false, "description": "Specifies if server-side encryption with provided encryption key (SSE-C) is enabled.", "example": false, "type": "boolean" } }, "required": [ "isEnabled" ], "title": "Update Capture Storage Configuration Request V1", "type": "object" }, "SaveTeamUserRequestV1": { "properties": { "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role ID assigned for the user in this team. **Mutually exclusive with standardTeamRole**.\n" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned for the user in this team. **Mutually exclusive with customTeamRoleId**.\\\n\\\n*ROLE_TEAM_SERVICE_MANAGER is only supported in Secure.*\n" } }, "title": "Create or Update Membership Request V1", "type": "object" }, "ScopeTypeV1": { "enum": [ "AGENT", "AWS_CLOUD_WATCH", "HOST_CONTAINER", "IBM_PLATFORM_METRICS", "PROMETHEUS_REMOTE_WRITE" ], "example": "PROMETHEUS_REMOTE_WRITE", "title": "Scope Type", "type": "string" }, "ScopeV1": { "properties": { "expression": { "example": "kubernetes.cluster.name in (\"test-env\")", "maxLength": 65356, "type": "string" }, "type": { "$ref": "#/components/schemas/ScopeTypeV1" } }, "required": [ "type", "expression" ], "title": "Scope", "type": "object" }, "ServiceAccountResponseV1": { "properties": { "dateCreated": { "description": "Date and time when the Service Account was created.", "example": "2024-08-23T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "expirationDate": { "description": "Date and time when the Service Account API key expires.", "example": "2024-06-15T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "lastUpdated": { "description": "Date and time when the Service Account was last updated.", "example": "2024-04-11T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "lastUsed": { "description": "Date and time when the Service Account API key was last used.", "example": "2024-06-15T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "name": { "description": "Service Account display name.", "example": "CI/CD service api key", "maxLength": 256, "type": "string" }, "systemRoles": { "description": "Array of System roles assigned to the global service account.", "items": { "example": "ROLE_SERVICE_ACCOUNT", "maxLength": 128, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "teamId": { "description": "Team ID of the team the service account is associated with.", "example": 32, "format": "int64", "maximum": 9223372036854776000, "minimum": 1, "type": "integer" }, "teamRole": { "description": "The predefined team role for a Service Account, or an ID of a custom role.", "example": "ROLE_TEAM_STANDARD", "maxLength": 256, "type": "string" } }, "title": "Service Account Response V1", "type": "object" }, "ServiceAccountWithKeyResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ServiceAccountResponseV1" }, { "properties": { "apiKey": { "description": "Service Account API key", "example": "123ab45c-d67e-89fg-0hij-1k23456l7890-n1MO", "maxLength": 256, "type": "string" } }, "type": "object" } ], "title": "Service Account With Key Response V1", "type": "object" }, "ServiceAccountsNotificationSettingsResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ServiceAccountsNotificationSettinsBase" } ], "title": "Service Accounts Notification Settings Response V1", "type": "object" }, "ServiceAccountsNotificationSettinsBase": { "description": "The base schema for the service accounts notification settings.", "properties": { "daysBeforeExpiry": { "default": [ 30, 7, 1 ], "description": "The number of days before the expiry of the service account when the notifications are to be sent.", "items": { "example": 3, "format": "int32", "maximum": 60, "minimum": 1, "type": "integer" }, "maxItems": 5, "maximum": 60, "minimum": 1, "type": "array" }, "isEnabled": { "description": "Whether the notification settings are enabled or not.", "example": true, "type": "boolean" }, "notificationChannelIds": { "description": "The list of notification channel IDs to which the notifications are to be sent.\\\n\\\nSupported types are **EMAIL** and **SLACK**.\n", "items": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ] }, "maxItems": 10, "type": "array" } }, "type": "object" }, "SsoSettingsBaseSchemaV1": { "properties": { "createUserOnLogin": { "description": "Flag to indicate if the user will be created automatically if not found in the system.", "example": true, "type": "boolean" }, "groupMappingAttributeName": { "description": "The group mapping attribute name.", "example": "groups", "maxLength": 64, "nullable": true, "type": "string" }, "isActive": { "description": "Flag to indicate if the SSO settings is active.", "example": true, "type": "boolean" }, "isGroupMappingEnabled": { "description": "Flag to indicate if group mapping support is enabled.", "example": true, "type": "boolean" }, "isPasswordLoginEnabled": { "description": "Flag to indicate if the user will be able to login with password.", "example": true, "type": "boolean" }, "isSingleLogoutEnabled": { "description": "Flag to indicate if the single logout support is enabled.", "example": true, "type": "boolean" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ], "description": "The product to which SSO settings is applied to. SSO settings are configured per specific product." } }, "title": "SSO Settings Base Schema V1", "type": "object" }, "SsoSettingsCreateRequestBaseV1": { "description": "Create Request SSO Settings Base Schema", "discriminator": { "mapping": { "OPENID": "#/components/schemas/OpenIdCreateRequestV1", "SAML": "#/components/schemas/SamlCreateRequestV1" }, "propertyName": "type" }, "properties": { "type": { "$ref": "#/components/schemas/SsoTypeV1" } }, "required": [ "type" ], "title": "SSO Settings Create Request Base V1", "type": "object" }, "SsoSettingsResponseBaseV1": { "description": "Response SSO Settings Base Schema", "discriminator": { "mapping": { "OPENID": "#/components/schemas/OpenIdConfigResponseV1", "SAML": "#/components/schemas/SamlResponseV1" }, "propertyName": "type" }, "properties": { "type": { "$ref": "#/components/schemas/SsoTypeV1" } }, "required": [ "type" ], "title": "SSO Settings Write Base Response V1", "type": "object" }, "SsoSettingsResponseV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsBaseSchemaV1" }, { "properties": { "config": { "$ref": "#/components/schemas/SsoSettingsResponseBaseV1" }, "dateCreated": { "description": "The date (in ISO 8601 format) when this SSO config was created.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "lastUpdated": { "description": "The date (in ISO 8601 format) when this SSO config was last updated.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "version": { "$ref": "#/components/schemas/UnlimitedLong" } }, "type": "object" } ], "title": "SSO Settings Write Response V1", "type": "object" }, "SsoSettingsUpdateRequestBaseV1": { "description": "Update Request SSO Settings Base Schema", "discriminator": { "mapping": { "OPENID": "#/components/schemas/OpenIdUpdateRequestV1", "SAML": "#/components/schemas/SamlUpdateRequestV1" }, "propertyName": "type" }, "properties": { "type": { "$ref": "#/components/schemas/SsoTypeV1" } }, "required": [ "type" ], "title": "SSO Settings Update Request Base V1", "type": "object" }, "SsoTypeV1": { "description": "Supported SSO types", "enum": [ "SAML", "OPENID" ], "example": "SAML", "title": "SSO Type", "type": "string" }, "TeamMapV1": { "description": "Determines the teams to which a group is mapped.", "properties": { "isForAllTeams": { "description": "If true, the group is mapped to all teams.\n", "example": false, "type": "boolean" }, "teamIds": { "description": "The list of teams to which group is mapped. It is empty when 'isForAllTeams' is true, otherwise it should have at least 1 element.\n", "example": [ 154, 187 ], "items": { "$ref": "#/components/schemas/UnlimitedLong" }, "maxItems": 8192, "type": "array" } }, "title": "Team Map", "type": "object" }, "TeamResponseV1": { "properties": { "additionalTeamPermissions": { "$ref": "#/components/schemas/AdditionalTeamPermissionsV1" }, "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role assigned by default to users added to this team. Mutually exclusive with 'standardTeamRoleId'.\n", "nullable": true }, "dateCreated": { "description": "The date (in ISO 8601 format) when this team was created.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "description": { "description": "A description of the team explaining what is it used for.", "example": "This team has access to scanning results", "maxLength": 2048, "nullable": true, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "isAllZones": { "description": "'True' if the users belonging to this team have access to all zones. Mutually exclusive with 'zoneIds'.\n", "example": false, "type": "boolean" }, "isDefaultTeam": { "description": "Specifies if the team is the default team. The default team is used to automatically assign new users to a team.", "example": false, "type": "boolean" }, "isImmutableTeam": { "description": "Specifies if the team is immutable. This is true if the team was created by the system with full access. It cannot be modified.", "example": false, "type": "boolean" }, "lastUpdated": { "description": "The date (in ISO 8601 format) when this team was last updated.", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "name": { "description": "The name of the team. It must be unique.", "example": "Scanning operations", "maxLength": 256, "type": "string" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Product" } ], "description": "The product to which the team is assigned to." }, "scopes": { "description": "The scopes available to the users of this team.", "items": { "$ref": "#/components/schemas/ScopeV1" }, "maxItems": 512, "type": "array" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned by default to users added to this team. Mutually exclusive with 'customTeamRoleId'.\n", "nullable": true }, "uiSettings": { "$ref": "#/components/schemas/UiSettingsV1" }, "version": { "$ref": "#/components/schemas/UnlimitedLong" }, "zoneIds": { "description": "The list of zones that users assigned to this team will have access to. Mutually exclusive with 'allZones'.\n", "items": { "$ref": "#/components/schemas/UnlimitedLong" }, "maxItems": 8192, "type": "array" } }, "title": "Team Response V1", "type": "object" }, "TeamRoleV1": { "description": "The standard team role provided by Sysdig.", "enum": [ "ROLE_TEAM_NONE", "ROLE_TEAM_READ", "ROLE_TEAM_SERVICE_MANAGER", "ROLE_TEAM_STANDARD", "ROLE_TEAM_EDIT", "ROLE_TEAM_MANAGER" ], "example": "ROLE_TEAM_READ", "title": "Team Role", "type": "string" }, "TeamUserResponseV1": { "properties": { "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "nullable": true }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "nullable": true }, "teamId": { "$ref": "#/components/schemas/UnlimitedLong" }, "userId": { "$ref": "#/components/schemas/UnlimitedLong" } }, "title": "Team User Response V1", "type": "object" }, "To": { "description": "To, expressed in Unix nanoseconds timestamp. The difference between `from` and `to` cannot be greater than 2 weeks.\nIf defined, `cursor` cannot be used.\n", "example": 1546300800000000000, "format": "int64", "maximum": 9223372036854776000, "minimum": 0, "type": "integer" }, "UiSettingsV1": { "description": "UI related settings.", "properties": { "entryPoint": { "$ref": "#/components/schemas/EntryPointV1" }, "theme": { "description": "The color assigned to the team.", "example": "#112233", "maxLength": 7, "type": "string" } }, "title": "UiSettings", "type": "object" }, "UnitPricingV1": { "description": "The unit pricing configuration used to compute costs.", "properties": { "cpu": { "description": "Hourly cost of one CPU.", "example": 0.031611, "type": "number" }, "ram": { "description": "Hourly cost of one GB of RAM.", "example": 0.004237, "type": "number" }, "spotCpu": { "description": "Hourly cost of one CPU for a spot node.", "nullable": true, "type": "number" }, "spotRam": { "description": "Hourly cost of one GB of RAM for a spot node.", "nullable": true, "type": "number" }, "storage": { "description": "Hourly cost of one GB of storage.", "example": 0.00005479452, "type": "number" } }, "required": [ "cpu", "ram", "storage" ], "title": "Unit Pricing V1", "type": "object" }, "UnlimitedLong": { "description": " ", "example": 1, "format": "int64", "minimum": 0, "type": "integer" }, "UpdateAccessKeyRequestV1": { "description": "Update access key request", "properties": { "agentLimit": { "description": "Maximum number of agents that can be connected with the access key", "example": 100, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "agentReservation": { "description": "Number of agents that are guaranteed to be available for the access key", "example": 5, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" }, "isEnabled": { "description": "Flag that indicates if the access key should be disabled or enabled", "example": true, "type": "boolean" }, "metadata": { "additionalProperties": { "example": "metaKey1:metaValue1", "maxLength": 76, "type": "string" }, "description": "Access key metadata (maximum of 20 key-value pairs where key can be up to 25 characters long and value can be up to 50 characters long)", "maxItems": 20, "type": "object" }, "teamId": { "description": "ID of team that owns the access key", "example": 13, "format": "int32", "maximum": 2147483647, "minimum": 0, "type": "integer" } }, "required": [ "isEnabled" ], "title": "Update Access Key Request", "type": "object" }, "UpdateGroupMappingRequestV1": { "properties": { "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role ID assigned for the user in this team. **Mutually exclusive with standardTeamRole**.\n", "nullable": true }, "groupName": { "description": "The group name matching the external provider name.", "example": "Admins_Mapped_Group", "maxLength": 256, "type": "string" }, "isAdmin": { "description": "Flag that indicates if the group is an admin group.", "example": false, "type": "boolean" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned for the user in this team. **Mutually exclusive with customTeamRoleId**.\n", "nullable": true }, "teamMap": { "$ref": "#/components/schemas/TeamMapV1" }, "weight": { "default": 32767, "description": "The weight of the group mapping that is used to determine the priority - a lower number has higher priority.", "example": 2, "format": "int16", "maximum": 32767, "minimum": 1, "type": "integer" } }, "required": [ "groupName", "teamMap", "isAdmin", "weight" ], "title": "Update Group Mapping Request V1", "type": "object" }, "UpdateInhibitionRuleRequestV1": { "properties": { "description": { "description": "Description of the inhibition rule.", "example": "this is an example description", "maxLength": 8192, "nullable": true, "type": "string" }, "equal": { "description": "List of labels that must have an equal value in the source and target alert for the inhibition to take effect.", "items": { "description": "Name of a label.", "example": "myLabel", "maxLength": 1024, "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "nullable": true, "type": "array" }, "isEnabled": { "default": true, "description": "Indicates if the inhibition rule is enabled or not.", "example": false, "type": "boolean" }, "name": { "description": "Name of the inhibition rule. If provided, must be unique.", "example": "this is an example name", "maxLength": 255, "nullable": true, "type": "string" }, "sourceMatchers": { "description": "List of source matchers for which one or more alerts have to exist for the inhibition to take effect.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" }, "targetMatchers": { "description": "List of target matchers that have to be fulfilled by the target alerts to be muted.", "items": { "$ref": "#/components/schemas/LabelMatcherV1" }, "maxItems": 100, "minItems": 1, "type": "array" }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource." } }, "required": [ "sourceMatchers", "targetMatchers", "version" ], "title": "Update Inhibition Rule Request v1" }, "UpdateIpFilterV1": { "description": "Request to update IP filter.", "properties": { "ipRange": { "description": "IP range in CIDR notation", "example": "192.168.0.0/24", "maxLength": 43, "type": "string" }, "isEnabled": { "example": true, "type": "boolean" }, "note": { "example": "London Office", "maxLength": 128, "type": "string" } }, "required": [ "ipRange", "isEnabled", "note" ], "title": "Update IP Filter Request V1", "type": "object" }, "UpdatePricingRequestV1": { "properties": { "clusterName": { "description": "The name of the cluster. Required when `type` is `CLUSTER`.", "example": "My pricing", "maxLength": 256, "nullable": true, "type": "string" }, "name": { "description": "The name of the pricing profile.", "example": "My pricing", "maxLength": 256, "type": "string" }, "spotLabel": { "description": "The name of a node label that is used to identify the node as a spot node.", "example": "cost-advisor-spot-node", "maxLength": 256, "nullable": true, "type": "string" }, "spotLabelValue": { "description": "The value of the spot node label.", "example": "true", "maxLength": 256, "nullable": true, "type": "string" }, "type": { "$ref": "#/components/schemas/PricingType" }, "unitPricing": { "allOf": [ { "$ref": "#/components/schemas/UnitPricingV1" } ], "description": "The unit pricing configuration used to compute costs." }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource.\n" } }, "required": [ "version", "type", "name", "unitPricing" ], "title": "Update Pricing Request", "type": "object" }, "UpdateServiceAccountsNotificationSettingsRequestV1": { "allOf": [ { "$ref": "#/components/schemas/ServiceAccountsNotificationSettinsBase" } ], "required": [ "isEnabled", "notificationChannelIds", "daysBeforeExpiry" ], "title": "Update Service Accounts Notification Settings Request V1", "type": "object" }, "UpdateSsoSettingsRequestV1": { "allOf": [ { "$ref": "#/components/schemas/SsoSettingsBaseSchemaV1" }, { "properties": { "config": { "$ref": "#/components/schemas/SsoSettingsUpdateRequestBaseV1" }, "version": { "$ref": "#/components/schemas/UnlimitedLong" } }, "type": "object" } ], "required": [ "version", "product", "config", "isActive", "createUserOnLogin", "isPasswordLoginEnabled", "isSingleLogoutEnabled", "isGroupMappingEnabled" ], "title": "Update SSO settings Request V1", "type": "object" }, "UpdateTeamRequestV1": { "properties": { "additionalTeamPermissions": { "$ref": "#/components/schemas/AdditionalTeamPermissionsV1" }, "customTeamRoleId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The custom team role assigned by default to users added to this team.\n" }, "description": { "description": "A description of the team explaining what is it used for.", "example": "User Team description", "maxLength": 2048, "type": "string" }, "isAllZones": { "description": "**True** if the users that are members of this team have access to all zones. **Mutually exclusive with zoneIds**.\\\n\\\n_Only supported in Secure features._\n", "example": false, "type": "boolean" }, "isDefaultTeam": { "description": "Specifies if this is the default team. The default team is used to automatically assign new users to a team.", "example": false, "type": "boolean" }, "name": { "description": "The name of the team.", "example": "User Team", "maxLength": 256, "type": "string" }, "scopes": { "description": "Scopes is a list of different scope types and filter values that will be applied to resources\nwhen accessed through the team.\n", "items": { "$ref": "#/components/schemas/ScopeV1" }, "maxItems": 512, "minItems": 1, "type": "array" }, "standardTeamRole": { "allOf": [ { "$ref": "#/components/schemas/TeamRoleV1" } ], "description": "The standard team role assigned by default to users added to this team.\n" }, "uiSettings": { "$ref": "#/components/schemas/UiSettingsV1" }, "version": { "$ref": "#/components/schemas/UnlimitedLong" }, "zoneIds": { "description": "The list of zones that users assigned to this team will have access to. **Mutually exclusive with allZones**.\\\n\\\n_Only supported in Secure features._\n", "items": { "$ref": "#/components/schemas/UnlimitedLong" }, "maxItems": 8192, "type": "array" } }, "required": [ "version", "name", "isDefaultTeam", "uiSettings", "scopes", "additionalTeamPermissions" ], "title": "Update Team Request V1", "type": "object" }, "UpdateUserDeactivationConfigurationRequestV1": { "properties": { "isEnabled": { "description": "Specifies if user deactivation is enabled for this customer.", "example": false, "type": "boolean" }, "numberDaysBeforeDeactivation": { "allOf": [ { "$ref": "#/components/schemas/DaysInYearInt" } ], "description": "Number of days before inactive users are deactivated.\n" } }, "required": [ "isEnabled", "numberDaysBeforeDeactivation" ], "title": "Update User Deactivation Configuration Request V1", "type": "object" }, "UpdateUserRequestV1": { "properties": { "firstName": { "description": "The name of the user.\n", "example": "john", "maxLength": 256, "type": "string" }, "isAdmin": { "description": "**True** if the user has Administration permissions.\n", "example": false, "type": "boolean" }, "lastName": { "description": "The surname of the user.\n", "example": "doe", "maxLength": 256, "type": "string" }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource.\n" } }, "required": [ "version" ], "title": "Update User Request V1", "type": "object" }, "UserDeactivationConfigurationResponseV1": { "properties": { "customerId": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The customer Id.\n" }, "isEnabled": { "description": "Specifies if user deactivation is enabled for this customer.", "example": false, "type": "boolean" }, "numberDaysBeforeDeactivation": { "allOf": [ { "$ref": "#/components/schemas/DaysInYearInt" } ], "description": "Number of days before inactive users are deactivated.\n" } }, "title": "User Deactivation Configuration Response V1", "type": "object" }, "UserResponseV1": { "properties": { "activationStatus": { "description": "The current activation status of the user.\n", "example": "confirmed", "maxLength": 256, "type": "string" }, "dateCreated": { "description": "The date and time when the user was created.\n", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "type": "string" }, "email": { "description": "The email address of the user.\n", "example": "john.doe@nomail.cc", "maxLength": 512, "type": "string" }, "firstName": { "description": "The name of the user.\n", "example": "john", "maxLength": 256, "nullable": true, "type": "string" }, "id": { "$ref": "#/components/schemas/UnlimitedLong" }, "isAdmin": { "description": "**True** if the user has Administration permissions.\n", "example": false, "type": "boolean" }, "lastName": { "description": "The last name of the user.\n", "example": "doe", "maxLength": 256, "nullable": true, "type": "string" }, "lastUpdated": { "description": "The date and time when the user was last updated.\n", "example": "2017-07-21T17:32:28Z", "format": "date-time", "maxLength": 64, "nullable": true, "type": "string" }, "version": { "allOf": [ { "$ref": "#/components/schemas/UnlimitedLong" } ], "description": "The current version of the resource.\n" } }, "title": "User Response V1", "type": "object" } }, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "## Introduction\n\nIBM Cloud® Monitoring is a cloud-native, container-intelligence management system that you can include as part of your IBM Cloud architecture. Use it to gain operational visibility into the performance and health of your applications, services, and platforms. It offers administrators, DevOps teams and developers full stack telemetry with advanced features to monitor and troubleshoot, define alerts, and design custom dashboards. For details about using IBM Cloud Monitoring, see the IBM Cloud [docs](https://cloud.ibm.com/docs/monitoring?topic=monitoring-getting-started#getting-started).\n\nYou can use the Monitoring API to manage dashboards, alerts, and teams. For more information, see the following documentation:\n- [Managing dashboards by using the Python client](https://cloud.ibm.com/docs/monitoring?topic=monitoring-dashboard_python)\n- [Managing alerts by using the Alerts API](https://cloud.ibm.com/docs/monitoring?topic=monitoring-alert_api)\n- [Managing alerts by using the Python client](https://cloud.ibm.com/docs/monitoring?topic=monitoring-alert_python)\n\nYou can use any of the following methods to manage the Monitoring service:\n- Python Client: You can use the Python client to manage the Monitoring service. The client is also known as the sdcclient. For more information, see [Using the Python client](https://cloud.ibm.com/docs/monitoring?topic=monitoring-python-client).\n- cURL: You can use cURL, a command line tool, from a terminal to manage the Monitoring service by using URL syntax. For more information, see [Using cURL](https://cloud.ibm.com/docs/monitoring?topic=monitoring-mon-curl).\n\nUse the following syntax from a terminal to run a cURL command:\n\n```shell\ncurl -X / <-H HEADERS,> [-d DATA]\n```\n\nWhere\n\n* `` indicates the type of REST API call that you want to make.\n* `` indicates the endpoint where the monitoring instance is available. For more information, see [Monitoring endpoints](https://cloud.ibm.com/docs/monitoring?topic=monitoring-endpoints). For example, the endpoint for an instance that is available in us-south is the following: `https://us-south.monitoring.cloud.ibm.com`\n* `` For more information about API URLs, see [Monitoring REST APIs](https://cloud.ibm.com/apidocs/monitor).\n* `HEADERS` add additional information such as information to authenticate with the IBM Cloud Monitoring service.\n* `DATA` allows you to pass additional information that might be required.\n\nThe code examples on this tab use the client library that is provided for Python.\n\n```python\nimport os\nimport sys\nsys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))\nfrom sdcclient import IbmAuthHelper, SdMonitorClient\n\n## Parse arguments.\ndef usage():\n print('usage: %s ' % sys.argv[0])\n print('ENDPOINT_URL: IBM Cloud endpoint URL (e.g. https://us-south.monitoring.cloud.ibm.com')\n print('API_KEY: IBM Cloud IAM API key. This key is used to retrieve an IAM access token.')\n print('INSTANCE_GUID: GUID of an IBM Cloud Monitoring instance.')\n sys.exit(1)\n\nif len(sys.argv) != 4:\n usage()\n\nURL = sys.argv[1]\nAPIKEY = sys.argv[2]\nGUID = sys.argv[3]\n\n## Instantiate the client\nibm_headers = IbmAuthHelper.get_headers(URL, APIKEY, GUID)\nsdclient = SdMonitorClient(sdc_url=URL, custom_headers=ibm_headers)\n```\n\n## Endpoint URL\n\nYou can use public and private endpoints. To find out about the available endpoints, see [REST API endpoints](https://cloud.ibm.com/docs/monitoring?topic=monitoring-endpoints#endpoints_rest_api).\n\nThe endpoint for the IBM Cloud Monitoring API is in the format: `https://cloud.ibm.com.monitoring.cloud.ibm.com/api` For example, the API endpoint for Dallas is: `https://us-south.monitoring.cloud.ibm.com/api` \n\nExample request to a Dallas endpoint:\n\n```text\ncurl -X GET https://us-south.monitoring.cloud.ibm.com/api/alerts/ -H \"Authorization: $AUTH_TOKEN\" -H \"IBMInstanceID: $GUID\" -H \"SysdigTeamID: $TEAM_ID\" -H \"content-type: application/json\"\n```\n\nReplace ``, `AUTH_TOKEN`, `GUID` and `TEAM_ID` in this example with the values for your particular API call.\n\nExample request to a Dallas endpoint\n\n```python\nimport os\nimport sys\nsys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])), '..'))\nfrom sdcclient import IbmAuthHelper, SdMonitorClient\n\n## Parse arguments.\ndef usage():\n print('usage: %s ' % sys.argv[0])\n print('ENDPOINT_URL: IBM Cloud endpoint URL (e.g. https://us-south.monitoring.cloud.ibm.com')\n print('API_KEY: IBM Cloud IAM API key. This key is used to retrieve an IAM access token.')\n print('INSTANCE_GUID: GUID of an IBM Cloud Monitoring instance.')\n sys.exit(1)\n\nif len(sys.argv) != 4:\n usage()\n\nURL = sys.argv[1]\nAPIKEY = sys.argv[2]\nGUID = sys.argv[3]\n\n## Instantiate the client\nibm_headers = IbmAuthHelper.get_headers(URL, APIKEY, GUID)\nsdclient = SdMonitorClient(sdc_url=URL, custom_headers=ibm_headers)\n```\n\n## Authentication\n\nAccess to IBM Cloud Monitoring is controlled by using IBM Cloud Identity and Access Management (IAM), which provides a unified approach to managing user identities and access control across your IBM Cloud services and applications.\n\nThis API requires IBM Cloud Identity and Access Management (IAM) authentication. You must pass an IAM token in the Authorization header of the request. You can retrieve your IAM access token, which is prefixed with `Bearer`, by running the [ibmcloud iam oauth-tokens](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_iam#ibmcloud_iam_oauth_tokens) command. You must also set the Account header to the unique ID for your IBM Cloud account. You can retrieve your Account ID by running the [ibmcloud account show](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_commands_account#ibmcloud_account_show) command.\n\nTo call each method, you must be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see [Managing access for IBM Cloud Monitoring](https://cloud.ibm.com/docs/monitoring?topic=monitoring-iam).\n\nIn a cURL command, add the following headers to authenticate with the IBM Cloud Monitoring service by using an IAM token:\n\n```shell\n-H \"Authorization: $AUTH_TOKEN\"\n-H \"IBMInstanceID: $GUID\"\n-H \"SysdigTeamID: $TEAM_ID\"\n```\n\nWhere\n\n* `IBMInstanceID` indicates the GUID of the IBM Cloud Monitoring instance that you want to target with the cURL command. \n\n To get the GUID of the monitoring instance, run the following command: `ibmcloud resource service-instance --output json | jq -r '.[].guid'`\n\n* `Authorization` indicates the IAM token that is used to authenticate with the IBM Cloud Monitoring service instance.\n\n To get the IAM `AUTH_TOKEN` token, run the following command: `ibmcloud iam oauth-tokens | awk '{print $4}'`\n \n For more information, see [Getting the IAM API token](https://cloud.ibm.com/docs/monitoring?topic=monitoring-api_token#api_iam_token_get). \n\n* `TeamID` indicates the GUID of a team.\n\n To get the GUID, see [Getting the ID of a team](https://cloud.ibm.com/docs/monitoring?topic=monitoring-team_id).\n\n### Authentication when using Python\n\nTo use IBM Cloud IAM authentication with the Python client, you must specify an endpoint, an API key, and the GUID from your IBM Cloud Monitoring instance.\n\nComplete the following steps from a terminal:\n\n1. Get the GUID of your IBM Cloud Monitoring instance. Run the following command:\n\n ```text\n ibmcloud resource service-instance --output json | jq -r '.[].guid'\n ```\n \n\n2. Get the API key. Run the following command to generate a user API key:\n\n ```text\n ibmcloud iam api-key-create KEY_NAME\n ```\n \n\n3. Get the [endpoint](https://cloud.ibm.com/docs/monitoring?topic=monitoring-endpoints) for the region where the monitoring instance is available. \n\n4. Add the following entries to your Python script:\n\n ```python\n from sdcclient import IbmAuthHelper, SdMonitorClient\n\n URL = \n # For example: URL = 'https://us-south.monitoring.cloud.ibm.com'\n\n APIKEY = \n\n GUID = \n\n ibm_headers = IbmAuthHelper.get_headers(URL, APIKEY, GUID)\n sdclient = SdMonitorClient(sdc_url=URL, custom_headers=ibm_headers)\n ```\n \n\n Where\n\n `` must be replaced with the endpoint where the monitoring instance is available. \n\n `` must be replaced with a valid IAM API key. [Learn more](https://cloud.ibm.com/docs/account?topic=account-userapikey).\n\n `` must be replaced with the GUID of the monitoring instance that you obtain in the previous step. \n\nYou can now use the **sdclient** to perform actions that will be authenticated by using IAM.\n\nIf you get the error `400 Client Error: Bad Request for url: https://iam.cloud.ibm.com/identity/token`, check the API key. The value that you are passing is not valid.\n\n## Auditing\n\nYou can monitor API activity within your account. Whenever an API method is called, an event is generated that you can then track and audit. The specific event type is listed for each method that generates auditing events. For methods that don't list any events, no events are generated.\n\nFor more information about how to track IBM Cloud Monitoring activity, see [Auditing the events for IBM Cloud Monitoring](https://cloud.ibm.com/docs/monitoring?topic=monitoring-at_events).\n\n## Error handling\n\nThe IBM Cloud Monitoring service uses standard HTTP response codes to indicate whether a method completed successfully. \n- A `200` response always indicates success. \n- A `400` type response indicates a failure. \n- A `500` type response usually indicates an internal system error.\n\n| HTTP Error Code | Description |\n|-----------------|-----------------------|\n| `200` | Success |\n| `201` | Success
E.g. Dashboard successfully created |\n| `400` | Bad Request |\n| `401` | Unauthorized |\n| `403` | Forbidden |\n| `404` | Not Found
E.g. Dashboard V3 not active |\n| `422` | Validation error, reason stated in the response body |\n| `500` | Internal Server Error |", "title": "Monitoring API", "version": "3.0", "x-last-updated": "2024-10-30" }, "openapi": "3.0.2", "paths": { "/monitor/alerts/v1/inhibition-rules": { "get": { "description": "Retrieve the list of inhibition rules.\\\n\\\n**Required permissions:** _inhibition-rules.read_ or _alerts.read_\n", "operationId": "getInhibitionRules", "parameters": [ { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Limit" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInhibitionRulesPaginatedResponseV1" } } }, "description": "The list of inhibition rules.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "List Inhibition Rules", "tags": [ "Inhibition Rules" ] }, "post": { "description": "Create an inhibition rule.\\\n\\\n**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_\n", "operationId": "createInhibitionRule", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInhibitionRuleRequestV1" } } }, "description": "The inhibition rule to be created.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InhibitionRuleResponseV1" } } }, "description": "Inhibition rule created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Create Inhibition Rule", "tags": [ "Inhibition Rules" ] } }, "/monitor/alerts/v1/inhibition-rules/{inhibitionRuleId}": { "delete": { "description": "Delete an inhibition rule by its ID.\\\n\\\n**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_\n", "operationId": "deleteInhibitionRuleById", "parameters": [ { "$ref": "#/components/parameters/InhibitionRulePath" } ], "responses": { "204": { "description": "Inhibition rule deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete Inhibition Rule", "tags": [ "Inhibition Rules" ] }, "get": { "description": "Retrieve an inhibition rule by ID.\\\n\\\n**Required permissions:** _inhibition-rules.read_ or _alerts.read_\n", "operationId": "getInhibitionRuleById", "parameters": [ { "$ref": "#/components/parameters/InhibitionRulePath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InhibitionRuleResponseV1" } } }, "description": "Inhibition rule found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get Inhibition Rule", "tags": [ "Inhibition Rules" ] }, "put": { "description": "Update an inhibition rule.\\\n\\\n**Required permissions:** _inhibition-rules.edit_ or _alerts.edit_\n", "operationId": "updateInhibitionRule", "parameters": [ { "$ref": "#/components/parameters/InhibitionRulePath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInhibitionRuleRequestV1" } } }, "description": "The new version of the inhibition rule.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InhibitionRuleResponseV1" } } }, "description": "Inhibition rule updated.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Update Inhibition Rule", "tags": [ "Inhibition Rules" ] } }, "/platform/v1/access-keys": { "get": { "description": "Retrieve a paginated list of access keys.\\\n\\\n**Required permissions:** _customer-access-keys.read_\n", "operationId": "getAccessKeysV1", "parameters": [ { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/OrderBy" }, { "$ref": "#/components/parameters/MultiFilter" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccessKeysPaginatedResponseV1" } } }, "description": "The access keys page.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "List Access Keys", "tags": [ "Access Keys" ] }, "post": { "description": "Create a new access key.\\\n\\\n**Required permissions:** _customer-access-keys.edit_\n", "operationId": "createAccessKeyV1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessKeyRequestV1" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKeyResponseV1" } } }, "description": "Access key created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Create Access Key", "tags": [ "Access Keys" ] } }, "/platform/v1/access-keys/{accessKeyId}": { "delete": { "description": "Delete an access key by id.\\\n\\\n**Required permissions:** customer-access-keys.edit_\n", "operationId": "deleteAccessKeyByIdV1", "parameters": [ { "$ref": "#/components/parameters/AccessKeyIdPath" } ], "responses": { "204": { "description": "Access key deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete Access Key", "tags": [ "Access Keys" ] }, "get": { "description": "Return an access key by id.\\\n\\\n**Required permissions:** _customer-access-keys.read_\n", "operationId": "getAccessKeyByIdV1", "parameters": [ { "$ref": "#/components/parameters/AccessKeyIdPath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKeyResponseV1" } } }, "description": "Access key found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get Access Key", "tags": [ "Access Keys" ] }, "put": { "description": "Update an access key by id.\\\n\\\n**Required permissions:** _customer-access-keys.edit_\n", "operationId": "updateAccessKeyByIdV1", "parameters": [ { "$ref": "#/components/parameters/AccessKeyIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessKeyRequestV1" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessKeyResponseV1" } } }, "description": "Access key updated.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Update Access Key", "tags": [ "Access Keys" ] } }, "/platform/v1/teams": { "get": { "description": "Retrieve a paginated list of teams.\\\n\\\n**Required permissions:** _customer-teams.read_\n", "operationId": "getTeamsV1", "parameters": [ { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/OrderBy" }, { "$ref": "#/components/parameters/Filter" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamsPaginatedResponseV1" } } }, "description": "The teams page.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "List Teams", "tags": [ "Teams" ] }, "post": { "description": "Create a new team.\\\n\\\n**Required permissions:** _teams.create_\n", "operationId": "createTeamV1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamRequestV1" } } }, "description": "The payload required to create a new team." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponseV1" } } }, "description": "Team created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Create Team", "tags": [ "Teams" ] } }, "/platform/v1/teams/{teamId}": { "delete": { "description": "Delete a team by its ID.\\\n\\\n**Required permissions:** _teams.edit_\n", "operationId": "deleteTeamByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "responses": { "204": { "description": "Team deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete Team", "tags": [ "Teams" ] }, "get": { "description": "Return a team by ID.\\\n\\\n**Required permissions:** _customer-teams.read_\n", "operationId": "getTeamByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponseV1" } } }, "description": "Team found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get Team", "tags": [ "Teams" ] }, "put": { "description": "Update a team by its ID.\\\n\\\n**Required permissions:** _teams.edit_\n", "operationId": "updateTeamByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamRequestV1" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponseV1" } } }, "description": "Team updated.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Update Team", "tags": [ "Teams" ] } }, "/platform/v1/teams/{teamId}/service-accounts": { "get": { "description": "Retrieve a paginated list of team service accounts.\\\n\\\n**Required permissions:** _team-service-accounts.read_\n", "operationId": "getTeamServiceAccountsV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/OrderBy" }, { "$ref": "#/components/parameters/MultiFilter" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetServiceAccountsPaginatedResponseV1" } } }, "description": "The team service accounts page.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "List Team Service Accounts", "tags": [ "Service Accounts" ] }, "post": { "description": "Create a new team service account.\\\n\\\n**Required permissions:** _team-service-accounts.edit_\n", "operationId": "createTeamServiceAccountV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamServiceAccountRequestV1" } } }, "description": "The payload required to create a new team service account." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountWithKeyResponseV1" } } }, "description": "Team service account created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "409": { "$ref": "#/components/responses/Conflict" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Create a Team Service Account", "tags": [ "Service Accounts" ] } }, "/platform/v1/teams/{teamId}/service-accounts/{serviceAccountId}": { "delete": { "description": "Delete a team service account by ID.\\\n\\\n**Required permissions:** _team-service-accounts.edit_\n", "operationId": "deleteTeamServiceAccountByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/ServiceAccountIdPath" } ], "responses": { "204": { "description": "Team service account deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete a Team Service Account", "tags": [ "Service Accounts" ] }, "get": { "description": "Return a team service account by ID.\\\n\\\n**Required permissions:** _team-service-accounts.read_\n", "operationId": "getTeamServiceAccountByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/ServiceAccountIdPath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountResponseV1" } } }, "description": "Team service account found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get a Team Service Account", "tags": [ "Service Accounts" ] } }, "/platform/v1/teams/{teamId}/service-accounts/notification-settings": { "delete": { "description": "Delete Service Accounts Notification Settings for a given team.\\\n\\\n**Required permissions:** _service-accounts-notification-settings.edit_\n", "operationId": "deleteServiceAccountsNotificationSettingsV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "responses": { "204": { "description": "Service Accounts Notification Settings deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete Service Accounts Notification Settings", "tags": [ "Service Accounts Notification Settings" ] }, "get": { "description": "Return Service Accounts Notification Settings for a given team.\\\n\\\n**Required permissions:** _service-accounts-notification-settings.read_\n", "operationId": "getServiceAccountsNotificationSettingsV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountsNotificationSettingsResponseV1" } } }, "description": "Service Accounts Notification Settings found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get Service Accounts Notification Settings", "tags": [ "Service Accounts Notification Settings" ] }, "post": { "description": "Create a new Notification Settings for Service Accounts which belong to a specific team.\\\n\\\n**Required permissions:** _service-accounts-notification-settings.edit_\n", "operationId": "createServiceAccountsNotificationSettingsV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateServiceAccountsNotificationSettingsRequestV1" } } }, "description": "The payload required to create Service Accounts Notification Settings." }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountsNotificationSettingsResponseV1" } } }, "description": "Service Accounts Notification Settings created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Create Service Accounts Notification Settings", "tags": [ "Service Accounts Notification Settings" ] }, "put": { "description": "Update Service Accounts Notification Settings for a given team.\\\n\\\n**Required permissions:** _service-accounts-notification-settings.edit_\n", "operationId": "updateServiceAccountsNotificationSettingsV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccountsNotificationSettingsRequestV1" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceAccountsNotificationSettingsResponseV1" } } }, "description": "Service Accounts Notification Settings updated.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Update Service Accounts Notification Settings", "tags": [ "Service Accounts Notification Settings" ] } }, "/platform/v1/teams/{teamId}/users": { "get": { "description": "Retrieve a paginated list of memberships in a given team ID.\\\n\\\n**Required permissions:** _memberships.read_\n", "operationId": "getTeamUsersV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/Offset" }, { "$ref": "#/components/parameters/Limit" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTeamUsersPaginatedResponseV1" } } }, "description": "The memberships page.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "List Memberships", "tags": [ "Teams" ] } }, "/platform/v1/teams/{teamId}/users/{userId}": { "delete": { "description": "Delete a membership defined by its ID.\\\n\\\n**Required permissions:** _memberships.edit_\n", "operationId": "deleteTeamUserByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/UserIdPath" } ], "responses": { "204": { "description": "Membership deleted.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Delete Membership", "tags": [ "Teams" ] }, "get": { "description": "Return a membership by its ID.\\\n\\\n**Required permissions:** _memberships.read_\n", "operationId": "getTeamUserByIdV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/UserIdPath" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUserResponseV1" } } }, "description": "Membership found.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Get Membership", "tags": [ "Teams" ] }, "put": { "description": "Add or update a membership.\n\n| Permission | Description |\n| -----------------------| --------------------------------------------------------------------------------------------------------|\n| memberships.edit | Required to create a new membership. |\n| memberships-roles.edit | Required to change roles of an existing membership or to create a new membership with a specific role. |\n", "operationId": "saveTeamUserV1", "parameters": [ { "$ref": "#/components/parameters/TeamIdPath" }, { "$ref": "#/components/parameters/UserIdPath" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveTeamUserRequestV1" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUserResponseV1" } } }, "description": "Membership updated.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUserResponseV1" } } }, "description": "Membership created.", "headers": { "X-RateLimit-Limit": { "description": "Maximum number of allowed requests per minute.", "schema": { "format": "int32", "maximum": 4096, "minimum": 1, "type": "integer" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "summary": "Save Membership", "tags": [ "Teams" ] } }, "/api/v3/dashboards": { "post": { "tags": [ "Dashboard V3" ], "summary": "Creates a new dashboard", "operationId": "createDashboard", "parameters": [ { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } }, "required": true }, "responses": { "201": { "description": "Dashboard successfully created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v3/dashboards/bulk/delete": { "post": { "tags": [ "Dashboard Bulk Actions API" ], "summary": "Bulk delete a set of dashboards", "operationId": "bulkDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "Bulk delete operation completed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkActionResponse" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/bulk/favorite/set": { "post": { "tags": [ "Dashboard Bulk Actions API" ], "summary": "Bulk set dashboards as Favorite", "operationId": "bulkSetFavorite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "Bulk set as favorite operation completed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkActionResponse" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/bulk/favorite/unset": { "post": { "tags": [ "Dashboard Bulk Actions API" ], "summary": "Bulk unset dashboards as Favorite", "operationId": "bulkUnsetFavorite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkActionRequest" } } }, "required": true }, "responses": { "200": { "description": "Bulk unset as favorite operation completed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BulkActionResponse" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/convertV2": { "post": { "tags": [ "Dashboard V3" ], "summary": "Convert Dashboard V2 into a Dashboard V3", "operationId": "convertV2ToV3", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardV2Wrapper" } } }, "required": true }, "responses": { "200": { "description": "Dashboard successfully converted to V3", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/convertWidgets": { "post": { "tags": [ "Dashboard V3" ], "summary": "Convert Dashboard V2 Widgets into DashboardV3Panels", "operationId": "convertWidgetsToPanels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetConverterRequest" } } }, "required": true }, "responses": { "200": { "description": "Dashboard widgets successfully converted", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/WidgetConverterResponse" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/list{?mostPopular,recentlyViewed}": { "get": { "tags": [ "Dashboard Listing API" ], "summary": "List all dashboards accessible by the user including custom, shared and libraries. Displays also favourites, recently viewed and most recent", "operationId": "listAllDashboardsV3", "parameters": [ { "name": "mostPopular", "in": "query", "description": "Return the max N most popular dashboards for team a user is member of", "required": false, "schema": { "type": "integer", "format": "int32", "default": 5 } }, { "name": "recentlyViewed", "in": "query", "description": "Return the max N most recently viewed dashboards for the user in the team", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardListWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v3/dashboards/transfer": { "post": { "tags": [ "Dashboard V3" ], "summary": "Transfer the ownership of a set of dashboards to another user", "operationId": "transferOwnership", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardV3Transferrequest" } } }, "required": true }, "responses": { "200": { "description": "Simulation result of transfer if specified. Otherwise dashboards successfully transferred to the new user", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Dashboardtransferevaluationresults" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Invalid owner or target owner", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Dashboardtransferevaluationresults" } } } } } } }, "/api/v3/dashboards/{id}": { "get": { "tags": [ "Dashboard V3" ], "summary": "Get a single dashboard by id", "operationId": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Dashboard V3", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "The user has no permissions to access the given dashboard. It may include a list of sharing teams which the user can access the dashboard from", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardV3SharingMemberSettings" } } } } }, "404": { "description": "Dashboard not found for the customer", "content": { "*/*": { "schema": { "type": "object" } } } } }, "x-audit_event": { "audit_group": "dashboard" } }, "put": { "tags": [ "Dashboard V3" ], "summary": "Update a given dashboard", "operationId": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } }, "required": true }, "responses": { "200": { "description": "Dashboard successfully updated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "The user has no permissions to update the given dashboard", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "404": { "description": "Dashboard not found for the customer", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "409": { "description": "Dashboard V3 version not matching the current stored version", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } } }, "x-audit_event": { "audit_group": "dashboard" } }, "delete": { "tags": [ "Dashboard V3" ], "summary": "Delete a given dashboard", "operationId": "delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Dashboard successfully deleted", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "The user has no permissions to delete the given dashboard", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "404": { "description": "Dashboard not found for the customer", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } } }, "x-audit_event": { "audit_group": "dashboard" } }, "patch": { "tags": [ "Dashboard V3" ], "summary": "Set/Unset the dashboard as favorite for the current user", "operationId": "setDashboardAsFavorite", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardPatchRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Dashboard favorite successfully updated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "The user has no permissions to update the given dashboard", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "404": { "description": "Dashboard not found for the customer", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v3/dashboards/{id}/sharing": { "get": { "tags": [ "Dashboard V3" ], "summary": "Get dashboard sharing teams", "operationId": "getDashboardSharing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Dashboard V3", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3Wrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Dashboard not found for the customer", "content": { "*/*": { "schema": { "type": "object" } } } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v3/dashboards?content{&autoCreated,content,requiredPermission,shared,team}": { "get": { "tags": [ "Dashboard V3" ], "summary": "List all dashboards accessible by the user in light mode with or without panels depending on content type", "operationId": "listLightWithContent", "parameters": [ { "name": "autoCreated", "in": "query", "description": "Only auto created dashboards (deprecated param)", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "content", "in": "query", "description": "Include list of panels for every dashboard", "required": true, "schema": { "type": "string", "enum": [ "simpleList", "searchInfo" ] } }, { "name": "requiredPermission", "in": "query", "description": "Only dashboards with the specific permission", "required": false, "schema": { "type": "string", "enum": [ "dashboards.read", "dashboards.edit", "dashboards.delete", "dashboards.sharing", "dashboards.transfer" ] } }, { "name": "shared", "in": "query", "description": "Only dashboards shared to other users", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "team", "in": "query", "description": "Return dashboards for the given team id. Otherwise for the current user's team", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LightDashboardWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v3/dashboards?light=true{&autoCreated,content,light,requiredPermission,shared,team}": { "get": { "tags": [ "Dashboard V3" ], "summary": "List all dashboards accessible by the user in light mode without panels and layout", "operationId": "listLight", "parameters": [ { "name": "autoCreated", "in": "query", "description": "Only auto created dashboards (deprecated param)", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "content", "in": "query", "description": "Include list of panels for every dashboard", "required": false, "schema": { "type": "string", "default": "simpleList" } }, { "name": "light", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "requiredPermission", "in": "query", "description": "Only dashboards with the specific permission", "required": false, "schema": { "type": "string", "enum": [ "dashboards.read", "dashboards.edit", "dashboards.delete", "dashboards.sharing", "dashboards.transfer" ] } }, { "name": "shared", "in": "query", "description": "Only dashboards shared to other users", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "team", "in": "query", "description": "Return dashboards for the given team id. Otherwise for the current user's team", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LightDashboardWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v3/dashboards{?autoCreated,shared,team}": { "get": { "tags": [ "Dashboard V3" ], "summary": "List all dashboards accessible for the user", "operationId": "listAll", "parameters": [ { "name": "autoCreated", "in": "query", "description": "Only auto created dashboards", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "shared", "in": "query", "description": "Only shared dashboards", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "team", "in": "query", "description": "Return dashboards for the given team id", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "x-sysdig-public-notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DashboardV3FullDashboardDTOsWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "dashboard" } } }, "/api/v1/silencingRules": { "get": { "tags": [ "Silencing Rules" ], "summary": "Get all the Silencing Rule belonging to the current logged user", "operationId": "findAll", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } }, "post": { "tags": [ "Silencing Rules" ], "summary": "Create a new Silencing Rule", "operationId": "createSilencingRule", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } }, "required": true }, "responses": { "201": { "description": "Silencing Rule successfully created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } } } } }, "/api/v1/silencingRules/delete": { "post": { "tags": [ "Silencing Rules" ], "summary": "Delete all the requested Silencing Rules", "operationId": "bulkDeleteSilencingRules", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SilencingRuleBulkRequestWrapper" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": {} } }, "204": { "description": "Silencing Rules successfully deleted." }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body" } } } }, "/api/v1/silencingRules/disable": { "patch": { "tags": [ "Silencing Rules" ], "summary": "Disable all the requested Silencing Rules", "operationId": "bulkDisableSilencingRules", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SilencingRuleBulkRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Silencing Rules successfully disabled. All the disabled rules are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleResponseWrapper" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleResponseWrapper" } } } } } } }, "/api/v1/silencingRules/enable": { "patch": { "tags": [ "Silencing Rules" ], "summary": "Enable all the requested Silencing Rules", "operationId": "bulkEnableSilencingRules", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SilencingRuleBulkRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Silencing Rules successfully enabled. All the enabled silencingRules are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleResponseWrapper" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleResponseWrapper" } } } } } } }, "/api/v1/silencingRules/{silencingRuleId}": { "get": { "tags": [ "Silencing Rules" ], "summary": "Get a single Silencing Rule by id", "operationId": "findById", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "silencingRuleId", "in": "path", "description": "The rule ID to fetch", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Silencing Rule not found for the customer/team", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } } } }, "put": { "tags": [ "Silencing Rules" ], "summary": "Update a Silencing Rule by id", "operationId": "updateSilencingRule", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "silencingRuleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } }, "required": true }, "responses": { "200": { "description": "Silencing Rule successfully updated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Silencing Rule not found for customer/team", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SilencingRuleDTO" } } } } } }, "delete": { "tags": [ "Silencing Rules" ], "summary": "Delete a Silencing Rule by id", "operationId": "deleteById", "parameters": [ { "name": "silencingRuleId", "in": "path", "description": "The rule ID to delete", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Silencing Rule successfully deleted" }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Silencing Rule not found for the customer/team" } } } }, "/api/v2/alerts": { "post": { "tags": [ "Alerts V2" ], "summary": "Creates an alert", "operationId": "createAlertV2", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts/bulk": { "post": { "tags": [ "Alerts V2" ], "summary": "Bulk create alerts", "operationId": "bulkCreateAlert", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAlertWrapper" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ListAlertWrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts/create": { "post": { "tags": [ "Alerts V2" ], "summary": "Creates an alert. Note: This endpoint is deprecated in favour of the canonical root endpoint", "operationId": "deprecatedCreateAlertV2", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "deprecated": true, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts/delete": { "post": { "tags": [ "Alerts V2" ], "summary": "Delete all the requested Alerts", "operationId": "bulkDeleteAlerts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkRequestWrapper" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": {} } }, "204": { "description": "Alerts successfully deleted." }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body" } } } }, "/api/v2/alerts/disable": { "patch": { "tags": [ "Alerts V2" ], "summary": "Disable all the requested Alerts", "operationId": "bulkDisableAlerts", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "notificationResolution", "in": "query", "description": "Notification resolution strategy", "required": false, "schema": { "type": "string", "default": "SEND_ACKNOWLEDGED_NOTIFICATIONS", "enum": [ "DO_NOT_NOTIFY", "SEND_ACKNOWLEDGED_NOTIFICATIONS", "SEND_RESOLUTION_NOTIFICATIONS" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Alerts successfully disabled. All the disabled alerts are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } } } } }, "/api/v2/alerts/enable": { "patch": { "tags": [ "Alerts V2" ], "summary": "Enable all the requested Alerts", "operationId": "bulkEnableAlerts", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Alerts successfully enabled. All the enabled alerts are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } } } } }, "/api/v2/alerts/generateQuery": { "post": { "tags": [ "Alerts V2" ], "summary": "Given an alert configuration, generates the corresponding PromQL query", "operationId": "generatePromQLQueryForAlertV2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } }, "required": true }, "responses": { "200": { "description": "Alert promQL condition generated successfully", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertGeneratedQueryWrapper" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "400": { "description": "When it's not possible to generate the PromQL query for the given alert, please check the error message in the response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertGeneratedQueryWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts/groups{?filter}": { "get": { "tags": [ "Alerts V2" ], "summary": "Retrieve group names", "operationId": "getGroupNames", "parameters": [ { "name": "filter", "in": "query", "description": "filter to use when searching for groups", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Group list successfully retrieved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GroupListWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } } } }, "/api/v2/alerts/resolve": { "patch": { "tags": [ "Alerts V2" ], "summary": "Resolve events associated with all the requested Alerts", "operationId": "bulkResolutionAlerts", "parameters": [ { "name": "notificationResolution", "in": "query", "description": "Notification resolution strategy", "required": true, "schema": { "type": "string", "enum": [ "DO_NOT_NOTIFY", "SEND_RESOLUTION_NOTIFICATIONS" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkRequestWrapper" } } }, "required": true }, "responses": { "200": { "description": "Events successfully resolved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResponseWrapperListAlert" } } } } } } }, "/api/v2/alerts/restore": { "patch": { "tags": [ "Alerts V2" ], "summary": "Restore all the requested Alerts", "operationId": "bulkRestoreAlerts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertBulkRequestWrapper" } } }, "required": true }, "responses": { "204": { "description": "Alerts successfully restored." }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body" } } } }, "/api/v2/alerts/summary{?aggregatedEventsMs,alertStatus,deleted,direction,excludePolicyEvents,filter,ids,severities,sortBy,statuses,triggeredAlertsScope,view}": { "get": { "tags": [ "Alerts V2" ], "summary": "List alerts", "operationId": "listAlerts_1", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "aggregatedEventsMs", "in": "query", "description": "Milliseconds used to aggregate events if requested", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "alertStatus", "in": "query", "description": "Alert statuses (states or resolutions) to include when aggregating events and when searching for triggered alerts", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "deleted", "in": "query", "description": "Alert deletion flag (true if deleted, false if not)", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "direction", "in": "query", "description": "Direction of sorting", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] } }, { "name": "excludePolicyEvents", "in": "query", "description": "Exclude Secure events", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "filter", "in": "query", "description": "String filter to use when querying alerts", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "description": "List of alert IDs to list", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "severities", "in": "query", "description": "List of severities to use when filtering", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortBy", "in": "query", "description": "Property used for sorting", "required": false, "schema": { "type": "string", "default": "id" } }, { "name": "statuses", "in": "query", "description": "List of statuses to use when filtering", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "triggeredAlertsScope", "in": "query", "description": "Scope of triggered alerts", "required": false, "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "View filter for alerts list", "required": false, "schema": { "type": "string", "enum": [ "TRIGGERED", "UNREPORTED_DESCRIPTORS", "DEACTIVATED" ] } } ], "responses": { "200": { "description": "All the teams alerts, already enriched with notification channels. Alerts are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertListWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts/{alertId}": { "get": { "tags": [ "Alerts V2" ], "summary": "Get alert", "operationId": "getAlertV2", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "alertId", "in": "path", "description": "ID of the alert to fetch", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Alert was found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "When the alert does not exists or cannot be read by the user", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } } } }, "x-audit_event": { "audit_group": "alert" } }, "put": { "tags": [ "Alerts V2" ], "summary": "Update alert", "operationId": "updateAlertV2", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "required": false, "schema": { "type": "boolean" } }, { "name": "alertId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertV2Wrapper" } } }, "required": true }, "responses": { "200": { "description": "The update operation was successful", "content": { "*/*": { "schema": { "type": "object" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "400": { "description": "Invalid request, reason stated in the response body", "content": { "*/*": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "The selected alert was not found", "content": { "*/*": { "schema": { "type": "object" } } } }, "409": { "description": "A version conflict occurred while updating", "content": { "*/*": { "schema": { "type": "object" } } } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "type": "object" } } } } }, "x-audit_event": { "audit_group": "alert" } }, "delete": { "tags": [ "Alerts V2" ], "summary": "Delete alert", "operationId": "deleteAlertV2", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "The delete operation was successful" }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "The selected alert was not found" } }, "x-audit_event": { "audit_group": "alert" } }, "patch": { "tags": [ "Alerts V2" ], "summary": "Edit alert", "operationId": "patchAlertV2", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAlertV2Wrapper" } } }, "required": true }, "responses": { "204": { "description": "The restore operation was successful" }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "The selected alert was not found" } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/alerts{?aggregatedEventsMs,alertStatus,deleted,direction,excludePolicyEvents,filter,ids,severities,sortBy,statuses,triggeredAlertsScope,view}": { "get": { "tags": [ "Alerts V2" ], "summary": "List alerts", "operationId": "listAlerts", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "description": "Optional boolean header. Performs translation of metrics and labels into prometheus/public notation", "required": false, "schema": { "type": "boolean" } }, { "name": "aggregatedEventsMs", "in": "query", "description": "Milliseconds used to aggregate events if requested", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "alertStatus", "in": "query", "description": "Alert statuses (states or resolutions) to include when aggregating events and when searching for triggered alerts", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "deleted", "in": "query", "description": "Alert deletion flag (true if deleted, false if not)", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "direction", "in": "query", "description": "Direction of sorting", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] } }, { "name": "excludePolicyEvents", "in": "query", "description": "Exclude Secure events", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "filter", "in": "query", "description": "String filter to use when querying alerts", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "description": "List of alert IDs to list", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "severities", "in": "query", "description": "List of severities to use when filtering", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortBy", "in": "query", "description": "Property used for sorting", "required": false, "schema": { "type": "string", "default": "id" } }, { "name": "statuses", "in": "query", "description": "List of statuses to use when filtering", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "triggeredAlertsScope", "in": "query", "description": "Scope of triggered alerts", "required": false, "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "View filter for alerts list", "required": false, "schema": { "type": "string", "enum": [ "TRIGGERED", "UNREPORTED_DESCRIPTORS", "DEACTIVATED" ] } } ], "responses": { "200": { "description": "All the teams alerts, already enriched with notification channels. Alerts are returned in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AlertListWrapper" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "alert" } } }, "/api/v2/events": { "post": { "tags": [ "Events V2" ], "summary": "Creates a custom event", "operationId": "createCustomEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventWrapperCUSTOM" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCUSTOM" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } } }, "x-audit_event": { "audit_group": "event" } } }, "/api/v2/events/count": { "post": { "tags": [ "Events V2" ], "summary": "Get events count aggregated by time and severity", "description": "Computes an aggregated count of Sysdig Monitor events in a specific time interval, with the possibility to filter events based on a textual query (according to the search [syntax](https://docs.sysdig.com/en/docs/sysdig-monitor/events/filtering-and-searching-events/#search-syntax) and [searched fields](https://docs.sysdig.com/en/docs/sysdig-monitor/events/filtering-and-searching-events/#search-fields) for events), a scope, the type and source of the event and the severity.\nAlert events can also be filtered by alert state and/or acknowledgement status.\nUnless filtered by type using the `category` parameter, this endpoint will take into account all the available [event types](https://docs.sysdig.com/en/docs/sysdig-monitor/events/event-types/).\nResults are presented as a list of event count aggregated by the sampling interval and subsequently aggregated by event severity.\nThis endpoint is used to support the [Display of Dashboard-Specific Events](https://docs.sysdig.com/en/docs/sysdig-monitor/dashboards/using-dashboards/display-dashboard-specific-events/).", "operationId": "getCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventsCountFilterParams" } } }, "required": true }, "responses": { "200": { "description": "The events count", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventsCountDto" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Not Found", "content": { "application/json": {} } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventsCountDto" } } } } } } }, "/api/v2/events/{id}": { "put": { "tags": [ "Events V2" ], "summary": "Update a custom event", "operationId": "updateCustomEvent", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the event to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventWrapperCUSTOM" } } }, "required": true }, "responses": { "200": { "description": "Event has been successfully updated", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } }, "201": { "description": "Created", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Event was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } }, "422": { "description": "The update request contains errors. Details are provided in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } } }, "x-audit_event": { "audit_group": "event" } }, "delete": { "tags": [ "Events V2" ], "summary": "Delete an event", "operationId": "deleteCustomEvent", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of the event to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Event has been successfully deleted" }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Event was not found" } }, "x-audit_event": { "audit_group": "event" } } }, "/api/v2/events/{id}/resolve": { "patch": { "tags": [ "Events V2" ], "summary": "Resolve an alert event", "operationId": "resolve", "parameters": [ { "name": "X-Sysdig-Public-Notation", "in": "header", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "translateLabelsToPublicNotation", "in": "query", "description": "Optional boolean parameter. Performs translation of labels into prometheus/public notation. Only applies if translation of metrics into prometheus/public notation is also requested", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Event has been successfully resolved", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } }, "204": { "description": "No Content", "content": { "application/json": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": {} } }, "403": { "description": "Forbidden", "content": { "application/json": {} } }, "404": { "description": "Event was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } }, "422": { "description": "Validation error, reason stated in the response body", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EventWrapperCombinedEvent" } } } } } } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "description": "Sysdig Monitor Public API", "url": "https://api.us1.sysdig.com" } ], "tags": [ { "description": "The use of teams provides a strategic way to organize groups, streamline workflows, or protect data, as needed by an organization. Administrators who design and implement teams should have in-depth knowledge of organizational infrastructure and goals.", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/docs/administration/administration-settings/user-and-team-administration/manage-teams-and-roles/" }, "name": "Teams" }, { "description": "User deactivation configuration.", "name": "User Deactivation" }, { "description": "Manage Access Keys.", "name": "Access Keys", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/docs/administration/administration-settings/access-and-secrets/authentication-and-authorization-saas/" } }, { "description": "Group mappings are used to map groups from an external identity provider to teams and roles in the Sysdig platform.", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/docs/administration/administration-settings/access-and-secrets/group-mappings/" }, "name": "Group Mappings" }, { "description": "Service accounts notification settings are used to configure the notification settings for service accounts.", "name": "Service Accounts Notification Settings" }, { "description": "IP filtering is used to control access to the Sysdig platform based on specified IP ranges.\\\nNOTE: The feature can be activated via the `/platform/v1/ip-filters-settings` endpoint (or through the UI) only if at least one IP address or range is configured.\n", "name": "IP Filtering" }, { "description": "Permissions define the actions that you can perform in the Sysdig platform.", "name": "Permissions" }, { "description": "Capture storage configuration.", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/docs/administration/administration-settings/outbound-integrations/s3-capture-storage/" }, "name": "Capture Storage" }, { "description": "A custom role is an admin-defined role that allows Sysdig administrators to bundle a set of permissions and assign it to one or more users or teams.\n", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/custom-role/" }, "name": "Roles" }, { "description": "Manage service accounts.", "externalDocs": { "description": "Find out more", "url": "https://docs.sysdig.com/en/manage-teams-and-roles/" }, "name": "Service Accounts" }, { "description": "Cost Advisor helps you understand and predict your spending for Kubernetes environments. If you're using a cloud provider that Cost Advisor doesn't automatically support, you can still customize how it calculates costs. You can do this by setting up new default prices or by specifying different prices for specific Kubernetes clusters through this API.", "externalDocs": { "description": "Find out more about Billing Profiles", "url": "https://docs.sysdig.com/en/docs/sysdig-monitor/costs/billing-profiles/" }, "name": "Cost Advisor Custom Pricing" }, { "description": "The Sysdig API for Metrics Management facilitates the listing, disabling, and re-enabling of metrics associated with Prometheus Jobs. These Jobs determine how the Sysdig Agent collects metrics from specified endpoints.", "name": "Metrics Collection" }, { "description": "Inhibition Rules allow muting alert occurrences based on the triggering status of other alert occurrences.", "name": "Inhibition Rules" } ] }