openapi: 3.2.0
info:
title: Alert Manager Count API
version: '1.0'
servers:
- url: https://dev-cloud.acronis.com/api/alert_manager/v1
variables: {}
tags:
- name: Count
paths:
/count:
get:
operationId: FetchAlertCounters
description: Fetches the alert counters that may be grouped by optional parameters.
parameters:
- name: embed_tenants
description: If true, alert counters will be grouped by tenants.
in: query
schema:
description: If true, alert counters will be grouped by tenants.
type: boolean
- name: embed_types
description: 'If true, alert counters will be grouped by alert types. When combined with `embed_severities` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.
'
in: query
schema:
description: 'If true, alert counters will be grouped by alert types. When combined with `embed_severities` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.
'
type: boolean
- name: embed_severities
description: 'If true, alert counters will be grouped by alert severities. When combined with `embed_types` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.
'
in: query
schema:
description: 'If true, alert counters will be grouped by alert severities. When combined with `embed_types` alert counters will be grouped first by severities and then by types. This parameter is mutually exclusive with the `embed_categories` parameter.
'
type: boolean
- name: embed_categories
description: 'If true, alert counters will be grouped by alert categories. This parameter is mutually exclusive with the `embed_types` and `embed_severities` parameters.
'
in: query
schema:
description: 'If true, alert counters will be grouped by alert categories. This parameter is mutually exclusive with the `embed_types` and `embed_severities` parameters.
'
type: boolean
responses:
'200':
description: Live statistics for current alerts.
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Request is refused because authentication parameters are invalid.
content:
text/plain:
schema:
example: "\n \n 401 Authorization Required\n \n \n \n 401 Authorization Required
\n \n
\n nginx\n \n\n"
'403':
description: 'A security error due to an issue with tenant security claim: invalid tenant in the access token, tenant resolution failed and etc.
'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth_2_0:
- urn:acronis.com::alert_manager::viewer
tags:
- Count
summary: Fetch alert counters
x-summary-source: derived
x-operation-id-source: normalized
x-operation-id-original: Fetch alert counters
components:
schemas:
debugInfo:
description: Error debug information (map type)
type: object
TypesEmbed:
description: 'Alert counters per alert type. Object keys are identifiers of alert
types, values are counters of alerts of these types.
'
type: object
CountPerType:
description: Alert counters per type while grouping by severity as well.
type: object
required:
- total
properties:
total:
type: integer
types:
$ref: '#/components/schemas/TypesEmbed'
Report:
description: Count report.
type: object
required:
- total
properties:
severitiesAndTypes:
$ref: '#/components/schemas/SeveritiesAndTypesEmbed'
severities:
$ref: '#/components/schemas/SeveritiesEmbed'
categories:
$ref: '#/components/schemas/CategoriesEmbed'
types:
$ref: '#/components/schemas/TypesEmbed'
tenants:
description: A list of alert counters per tenant.
type: array
items:
$ref: '#/components/schemas/TenantCountResult'
total:
type: integer
Error:
description: Base error object
type: object
required:
- domain
- code
properties:
domain:
description: Error type or category. Can be ['Licensing','Access'] or name of service (for example 'PolicyManager' or 'VaultManager')
type: string
code:
description: Error id or code, unique in the domain. Same as in 'reason' field
type: string
reason:
description: Obsolete. Error id or code, unique in the domain. Same as in 'code' field
type: string
context:
description: Error context dictionary
type: object
kbLink:
$ref: '#/components/schemas/kbLinkInfo'
debug:
$ref: '#/components/schemas/debugInfo'
SeveritiesEmbed:
description: Alert counters per severity.
type: object
required:
- information
- warning
- error
- critical
properties:
information:
type: integer
warning:
type: integer
error:
type: integer
critical:
type: integer
kbLinkInfo:
description: Components for kblink
type: object
required:
- lineTag
- serCode
- version
- build
- product
- os
properties:
lineTag:
type: string
serCode:
type: string
version:
type: string
build:
type: integer
product:
type: string
os:
type: string
SeveritiesAndTypesEmbed:
description: Alert counters grouped by severity and then by type.
type: object
required:
- information
- warning
- error
- critical
properties:
information:
$ref: '#/components/schemas/CountPerType'
warning:
$ref: '#/components/schemas/CountPerType'
error:
$ref: '#/components/schemas/CountPerType'
critical:
$ref: '#/components/schemas/CountPerType'
CategoriesEmbed:
description: 'Alert counters per alert category. Object keys are identifiers of alert
categories, values are counters of alerts of these categories.
'
type: object
TenantCountResult:
description: Alert counters for a tenant.
type: object
required:
- locator
- id
- total
properties:
locator:
description: Locator of a tenant.
type: string
severitiesAndTypes:
$ref: '#/components/schemas/SeveritiesAndTypesEmbed'
severities:
$ref: '#/components/schemas/SeveritiesEmbed'
categories:
$ref: '#/components/schemas/CategoriesEmbed'
id:
description: Identifier of a tenant.
type: string
types:
$ref: '#/components/schemas/TypesEmbed'
total:
type: integer
securitySchemes:
oauth_2_0:
type: oauth2
description: OAuth 2.0 security scheme definition for a user authorization.
flows:
clientCredentials:
scopes:
urn:acronis.com::alert_manager::admin: ''
urn:acronis.com::alert_manager::viewer: ''
tokenUrl: https://dev-cloud.acronis.com/api/2/idp/token
password:
scopes:
urn:acronis.com::alert_manager::admin: ''
urn:acronis.com::alert_manager::viewer: ''
tokenUrl: https://dev-cloud.acronis.com/api/2/idp/token
authorizationCode:
scopes:
urn:acronis.com::alert_manager::admin: ''
urn:acronis.com::alert_manager::viewer: ''
authorizationUrl: https://dev-cloud.acronis.com/api/2/idp/authorize
tokenUrl: https://dev-cloud.acronis.com/api/2/idp/token
x-roles:
- name: public
id: '1'
description: public role
x-tags:
- public
- name: private
id: '2'
description: private role
x-tags:
- private