openapi: 3.0.1 info: contact: name: https://docs.yugabyte.com description: Alerts and Monitoring subset of the YugabyteDB Anywhere v1 REST API, split from the canonical platform-go-client OpenAPI bundle. license: name: Polyform Free Trial License 1.0.0 url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt termsOfService: TODO(chirag) title: YugabyteDB Anywhere v1 — Alerts and Monitoring version: v1 x-source: https://github.com/yugabyte/platform-go-client/blob/master/api/openapi.yaml x-split-from: yugabytedb-anywhere-v1-openapi.yaml externalDocs: description: About YugabyteDB Anywhere url: https://docs.yugabyte.com/latest/yugabyte-platform/ servers: - url: / tags: - name: Alerts - name: Audit - name: Grafana Dashboard - name: LoggingConfig - name: Metrics - name: PA Collector - name: Performance Advisor - name: Telemetry Provider paths: /api/v1/audit_logging_config: post: operationId: setAuditLoggingSettings parameters: - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AuditLoggingConfig' examples: SetAuditLoggingSettingsRequestExample: summary: Default setAuditLoggingSettings request x-microcks-default: true value: outputToStdout: true maxHistory: 30 fileNamePrefix: yb-platform- rolloverPattern: yyyy-MM-dd outputToFile: true description: Audit Logging config to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuditLoggingConfig' examples: SetAuditLoggingSettings200Example: summary: Default setAuditLoggingSettings 200 response x-microcks-default: true value: outputToStdout: true maxHistory: 30 fileNamePrefix: yb-platform- rolloverPattern: yyyy-MM-dd outputToFile: true description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Audit Logging Level tags: - LoggingConfig x-codegen-request-body-name: Audit Logging Config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_channel_templates: get: description: 'WARNING: This is a preview API that could change.' operationId: listAlertChannelTemplates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Alert channel templates ext with default values' type: array examples: ListAlertChannelTemplates200Example: summary: Default listAlertChannelTemplates 200 response x-microcks-default: true value: [] description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Alert Channel Templates tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_channel_templates/{acType}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteAlertChannelTemplates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acType required: true schema: type: string example: DEFAULT - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertChannelTemplates200Example: summary: Default deleteAlertChannelTemplates 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Alert Channel Templates tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getAlertChannelTemplates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acType required: true schema: type: string example: DEFAULT responses: '200': content: application/json: schema: $ref: '#/components/schemas/Alert channel templates ext with default values' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Alert Channel Templates tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change.' operationId: setAlertChannelTemplates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acType required: true schema: type: string example: DEFAULT - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertChannelTemplates' examples: SetAlertChannelTemplatesRequestExample: summary: Default setAlertChannelTemplates request x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 textTemplate: textTemplate type: Email titleTemplate: titleTemplate required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertChannelTemplates' examples: SetAlertChannelTemplates200Example: summary: Default setAlertChannelTemplates 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 textTemplate: textTemplate type: Email titleTemplate: titleTemplate description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Alert Channel Templates tags: - Alerts x-codegen-request-body-name: SetAlertChannelTemplatesRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_channels: get: description: 'WARNING: This is a preview API that could change.' operationId: listAlertChannels parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertChannel' type: array examples: ListAlertChannels200Example: summary: Default listAlertChannels 200 response x-microcks-default: true value: - customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Alert Channels tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change.' operationId: createAlertChannel parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertChannelFormData' examples: CreateAlertChannelRequestExample: summary: Default createAlertChannel request x-microcks-default: true value: name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate alertChannelUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertChannel' examples: CreateAlertChannel200Example: summary: Default createAlertChannel 200 response x-microcks-default: true value: customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Alert Channel tags: - Alerts x-codegen-request-body-name: CreateAlertChannelRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_channels/{acUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteAlertChannel parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertChannel200Example: summary: Default deleteAlertChannel 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Alert Channel tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getAlertChannel parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertChannel' examples: GetAlertChannel200Example: summary: Default getAlertChannel 200 response x-microcks-default: true value: customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get an Alert Channel tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: updateAlertChannel parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: acUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertChannelFormData' examples: UpdateAlertChannelRequestExample: summary: Default updateAlertChannel request x-microcks-default: true value: name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate alertChannelUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertChannel' examples: UpdateAlertChannel200Example: summary: Default updateAlertChannel 200 response x-microcks-default: true value: customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update an Alert Channel tags: - Alerts x-codegen-request-body-name: UpdateAlertChannelRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_configurations: post: description: 'WARNING: This is a preview API that could change.' operationId: createAlertConfiguration parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertConfiguration' examples: CreateAlertConfigurationRequestExample: summary: Default createAlertConfiguration request x-microcks-default: true value: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: '2022-12-12T13:07:18+00:00' defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertConfiguration' examples: CreateAlertConfiguration200Example: summary: Default createAlertConfiguration 200 response x-microcks-default: true value: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Alert Configuration tags: - Alerts x-codegen-request-body-name: CreateAlertConfigurationRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_configurations/list: post: description: 'WARNING: This is a preview API that could change.' operationId: listAlertConfigurations parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertConfigurationApiFilter' examples: ListAlertConfigurationsRequestExample: summary: Default listAlertConfigurations request x-microcks-default: true value: severity: SEVERE template: REPLICATION_LAG destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true destinationType: NO_DESTINATION targetType: PLATFORM target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertConfiguration' type: array examples: ListAlertConfigurations200Example: summary: Default listAlertConfigurations 200 response x-microcks-default: true value: - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Filtered List of Alert Configurations tags: - Alerts x-codegen-request-body-name: ListAlertConfigurationsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_configurations/page: post: description: 'WARNING: This is a preview API that could change.' operationId: pageAlertConfigurations parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertConfigurationPagedApiQuery' examples: PageAlertConfigurationsRequestExample: summary: Default pageAlertConfigurations request x-microcks-default: true value: filter: severity: SEVERE template: REPLICATION_LAG destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true destinationType: NO_DESTINATION targetType: PLATFORM target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertConfigurationPagedResponse' examples: PageAlertConfigurations200Example: summary: Default pageAlertConfigurations 200 response x-microcks-default: true value: entities: - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 hasPrev: true hasNext: true totalCount: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Alert Configurations (paginated) tags: - Alerts x-codegen-request-body-name: PageAlertConfigurationsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteAlertConfiguration parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configurationUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertConfiguration200Example: summary: Default deleteAlertConfiguration 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Alert Configuration tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getAlertConfiguration parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configurationUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertConfiguration' examples: GetAlertConfiguration200Example: summary: Default getAlertConfiguration 200 response x-microcks-default: true value: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get an Alert Configuration tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: updateAlertConfiguration parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configurationUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertConfiguration' examples: UpdateAlertConfigurationRequestExample: summary: Default updateAlertConfiguration request x-microcks-default: true value: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: '2022-12-12T13:07:18+00:00' defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertConfiguration' examples: UpdateAlertConfiguration200Example: summary: Default updateAlertConfiguration 200 response x-microcks-default: true value: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update an Alert Configuration tags: - Alerts x-codegen-request-body-name: UpdateAlertConfigurationRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert: post: description: 'WARNING: This is a preview API that could change.' operationId: sendTestAlert parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configurationUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: SendTestAlert200Example: summary: Default sendTestAlert 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Send Test Alert for Alert Configuration tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_destinations: get: description: 'WARNING: This is a preview API that could change.' operationId: listAlertDestinations parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertDestination' type: array examples: ListAlertDestinations200Example: summary: Default listAlertDestinations 200 response x-microcks-default: true value: - customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Alert Destinations tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change.' operationId: createAlertDestination parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertDestinationFormData' examples: CreateAlertDestinationRequestExample: summary: Default createAlertDestination request x-microcks-default: true value: channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertDestination' examples: CreateAlertDestination200Example: summary: Default createAlertDestination 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create an Alert Destination tags: - Alerts x-codegen-request-body-name: CreateAlertDestinationRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_destinations/{adUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteAlertDestination parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: adUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertDestination200Example: summary: Default deleteAlertDestination 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Alert Destination tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getAlertDestination parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: adUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertDestination' examples: GetAlertDestination200Example: summary: Default getAlertDestination 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get an Alert Destination tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: updateAlertDestination parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: adUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertDestinationFormData' examples: UpdateAlertDestinationRequestExample: summary: Default updateAlertDestination request x-microcks-default: true value: channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertDestination' examples: UpdateAlertDestination200Example: summary: Default updateAlertDestination 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update an Alert Destination tags: - Alerts x-codegen-request-body-name: UpdateAlertDestinationRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_notification_preview: post: description: 'WARNING: This is a preview API that could change.' operationId: alertNotificationPreview parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertTemplateVariablesFormData' examples: AlertNotificationPreviewRequestExample: summary: Default alertNotificationPreview request x-microcks-default: true value: variables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertTemplateVariablesList' examples: AlertNotificationPreview200Example: summary: Default alertNotificationPreview 200 response x-microcks-default: true value: customVariables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 systemVariables: - YUGABYTE_ALERT_STATUS - YUGABYTE_ALERT_STATUS description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Prepare Alert Notification Preview tags: - Alerts x-codegen-request-body-name: NotificationPreviewRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_template_settings: get: deprecated: true description: Deprecated since YBA version 2.20.0.0.

operationId: listAlertTemplateSettings parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertTemplateSettings' type: array examples: ListAlertTemplateSettings200Example: summary: Default listAlertTemplateSettings 200 response x-microcks-default: true value: - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Alert Template Settings - Deprecated tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK put: deprecated: true description: Deprecated since YBA version 2.20.0.0.

operationId: editAlertTemplateSettings parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertTemplateSettingsFormData' examples: EditAlertTemplateSettingsRequestExample: summary: Default editAlertTemplateSettings request x-microcks-default: true value: settings: - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertTemplateSettings' type: array examples: EditAlertTemplateSettings200Example: summary: Default editAlertTemplateSettings 200 response x-microcks-default: true value: - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create or Update Alert Template Settings List - Deprecated tags: - Alerts x-codegen-request-body-name: EditAlertTemplateSettingsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}: delete: deprecated: true description: Deprecated since YBA version 2.20.0.0.

operationId: deleteAlertTemplateSettings parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: settingsUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertTemplateSettings200Example: summary: Default deleteAlertTemplateSettings 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Alert Template Settings - Deprecated tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_template_variables: get: description: 'WARNING: This is a preview API that could change.' operationId: listAlertTemplateVariables parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertTemplateVariablesList' examples: ListAlertTemplateVariables200Example: summary: Default listAlertTemplateVariables 200 response x-microcks-default: true value: customVariables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 systemVariables: - YUGABYTE_ALERT_STATUS - YUGABYTE_ALERT_STATUS description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Alert Template Variables tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: editAlertTemplateVariables parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertTemplateVariablesFormData' examples: EditAlertTemplateVariablesRequestExample: summary: Default editAlertTemplateVariables request x-microcks-default: true value: variables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertTemplateVariable' type: array examples: EditAlertTemplateVariables200Example: summary: Default editAlertTemplateVariables 200 response x-microcks-default: true value: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create or Update Alert Template Variables tags: - Alerts x-codegen-request-body-name: EditAlertTemplateVariablesRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteAlertTemplateVariables parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: variableUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteAlertTemplateVariables200Example: summary: Default deleteAlertTemplateVariables 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete an Alert Template Variables tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alert_templates: post: description: 'WARNING: This is a preview API that could change.' operationId: listAlertTemplates parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertTemplateApiFilter' examples: ListAlertTemplatesRequestExample: summary: Default listAlertTemplates request x-microcks-default: true value: name: name targetType: PLATFORM required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AlertConfigurationTemplate' type: array examples: ListAlertTemplates200Example: summary: Default listAlertTemplates 200 response x-microcks-default: true value: - template: REPLICATION_LAG thresholdUnitName: thresholdUnitName thresholdMaxValue: 1.4658129805029452 active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdInteger: true thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 thresholdConditionReadOnly: true thresholdMinValue: 5.962133916683182 thresholdReadOnly: true defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Filtered List of Alert Configuration Templates tags: - Alerts x-codegen-request-body-name: ListTemplatesRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts: get: description: 'WARNING: This is a preview API that could change.' operationId: listOfAlerts parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Alert' type: array examples: ListOfAlerts200Example: summary: Default listOfAlerts 200 response x-microcks-default: true value: - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Alerts tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/acknowledge: post: deprecated: true description: Deprecated since YBA version 2.8.0.0.

operationId: acknowledgeByFilter parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertApiFilter' examples: AcknowledgeByFilterRequestExample: summary: Default acknowledgeByFilter request x-microcks-default: true value: sourceUUIDs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configurationTypes: - PLATFORM - PLATFORM sourceName: sourceName configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: - SEVERE - SEVERE states: - ACTIVE - ACTIVE uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Alert' type: array examples: AcknowledgeByFilter200Example: summary: Default acknowledgeByFilter 200 response x-microcks-default: true value: - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Acknowledge All Alerts - Deprecated tags: - Alerts x-codegen-request-body-name: AcknowledgeAlertsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/active: get: deprecated: true description: Deprecated since YBA version 2.8.0.0.

operationId: listActive parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Alert' type: array examples: ListActive200Example: summary: Default listActive 200 response x-microcks-default: true value: - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Active Alerts - Deprecated tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/count: post: description: 'WARNING: This is a preview API that could change.' operationId: countAlerts parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertApiFilter' examples: CountAlertsRequestExample: summary: Default countAlerts request x-microcks-default: true value: sourceUUIDs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configurationTypes: - PLATFORM - PLATFORM sourceName: sourceName configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: - SEVERE - SEVERE states: - ACTIVE - ACTIVE uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: format: int32 type: integer examples: CountAlerts200Example: summary: Default countAlerts 200 response x-microcks-default: true value: 100 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Count Alerts tags: - Alerts x-codegen-request-body-name: CountAlertsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/page: post: description: 'WARNING: This is a preview API that could change.' operationId: pageAlerts parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertPagedApiQuery' examples: PageAlertsRequestExample: summary: Default pageAlerts request x-microcks-default: true value: filter: sourceUUIDs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configurationTypes: - PLATFORM - PLATFORM sourceName: sourceName configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: - SEVERE - SEVERE states: - ACTIVE - ACTIVE uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertPagedResponse' examples: PageAlerts200Example: summary: Default pageAlerts 200 response x-microcks-default: true value: entities: - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 hasPrev: true hasNext: true totalCount: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Alerts (paginated) tags: - Alerts x-codegen-request-body-name: PageAlertsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/{alertUUID}: get: description: 'WARNING: This is a preview API that could change.' operationId: get parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: alertUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Alert' examples: Get200Example: summary: Default get 200 response x-microcks-default: true value: severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Details of an Alert tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge: post: description: 'WARNING: This is a preview API that could change.' operationId: acknowledge parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: alertUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/Alert' examples: Acknowledge200Example: summary: Default acknowledge 200 response x-microcks-default: true value: severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Acknowledge an Alert tags: - Alerts x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/pa_collector: get: description: YbaApi Internal. operationId: listAllPACollectors parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PA Collector Details Model' type: array examples: ListAllPACollectors200Example: summary: Default listAllPACollectors 200 response x-microcks-default: true value: [] description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All PA Collectors tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: YbaApi Internal. operationId: createPACollector parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PACollector' examples: CreatePACollectorRequestExample: summary: Default createPACollector request x-microcks-default: true value: apiToken: apiToken customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: metricsPassword metricsUsername: metricsUsername metricsUrl: metricsUrl paApiToken: paApiToken paUrl: paUrl ybaUrl: ybaUrl metricsScrapePeriodSecs: 0 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PACollector' examples: CreatePACollector200Example: summary: Default createPACollector 200 response x-microcks-default: true value: apiToken: apiToken customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: metricsPassword metricsUsername: metricsUsername metricsUrl: metricsUrl paApiToken: paApiToken paUrl: paUrl ybaUrl: ybaUrl metricsScrapePeriodSecs: 0 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create PA Collector tags: - PA Collector x-codegen-request-body-name: collectorData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/pa_collector/{paUUID}: delete: description: YbaApi Internal. operationId: deletePACollector parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: paUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: force schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: type: boolean examples: DeletePACollector200Example: summary: Default deletePACollector 200 response x-microcks-default: true value: true description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete PA Collector tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: YbaApi Internal. operationId: getPACollector parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: paUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/PA Collector Details Model' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get PA Collector tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: YbaApi Internal. operationId: editPACollector parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: paUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: force schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PACollector' examples: EditPACollectorRequestExample: summary: Default editPACollector request x-microcks-default: true value: apiToken: apiToken customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: metricsPassword metricsUsername: metricsUsername metricsUrl: metricsUrl paApiToken: paApiToken paUrl: paUrl ybaUrl: ybaUrl metricsScrapePeriodSecs: 0 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PACollector' examples: EditPACollector200Example: summary: Default editPACollector 200 response x-microcks-default: true value: apiToken: apiToken customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: metricsPassword metricsUsername: metricsUsername metricsUrl: metricsUrl paApiToken: paApiToken paUrl: paUrl ybaUrl: ybaUrl metricsScrapePeriodSecs: 0 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit PA Collector tags: - PA Collector x-codegen-request-body-name: collectorData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendation_state_change/page: post: description: 'WARNING: This is a preview API that could change.' operationId: pageAuditInfo parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/StateChangeAuditInfoPagedQuery' examples: PageAuditInfoRequestExample: summary: Default pageAuditInfo request x-microcks-default: true value: filter: customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 recommendationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: id direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/StateChangeAuditInfoPagedResponse' examples: PageAuditInfo200Example: summary: Default pageAuditInfo 200 response x-microcks-default: true value: entities: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 hasPrev: true hasNext: true totalCount: 6 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Performance Recommendations State Change Audit Events (paginated) tags: - Performance Advisor x-codegen-request-body-name: PageStateChangeAuditInfoRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendations: delete: description: 'WARNING: This is a preview API that could change.' operationId: delete parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendationFilter' examples: DeleteRequestExample: summary: Default delete request x-microcks-default: true value: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: Delete200Example: summary: Default delete 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Performance Recommendations tags: - Performance Advisor x-codegen-request-body-name: DeletePerformanceRecommendationsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendations/hide: post: description: YbaApi Internal. operationId: hide parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendationFilter' examples: HideRequestExample: summary: Default hide request x-microcks-default: true value: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: Hide200Example: summary: Default hide 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Hide Performance Recommendations tags: - Performance Advisor x-codegen-request-body-name: HidePerformanceRecommendationsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendations/page: post: description: 'WARNING: This is a preview API that could change.' operationId: page parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendationPagedQuery' examples: PageRequestExample: summary: Default page request x-microcks-default: true value: filter: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN offset: 6 needTotalCount: true limit: 0 sortBy: id direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendationPagedResponse' examples: Page200Example: summary: Default page 200 response x-microcks-default: true value: entities: - new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX - new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX hasPrev: true hasNext: true totalCount: 6 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Performance Recommendations (paginated) tags: - Performance Advisor x-codegen-request-body-name: PagePerformanceRecommendationRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendations/resolve: post: description: YbaApi Internal. operationId: resolve parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendationFilter' examples: ResolveRequestExample: summary: Default resolve request x-microcks-default: true value: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: Resolve200Example: summary: Default resolve 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Resolve Performance Recommendations tags: - Performance Advisor x-codegen-request-body-name: ResolvePerformanceRecommendationsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/performance_recommendations/{rUUID}: get: description: 'WARNING: This is a preview API that could change.' operationId: get parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: rUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerformanceRecommendation' examples: Get200Example: summary: Default get 200 response x-microcks-default: true value: new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Performance Recommendation Details tags: - Performance Advisor x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_info: get: operationId: getTaskAudit parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: tUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Audit' examples: GetTaskAudit200Example: summary: Default getTaskAudit 200 response x-microcks-default: true value: auditID: 0 targetID: targetID additionalDetails: '{}' taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 target: User userAddress: userAddress apiMethod: GET customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 payload: '{}' action: Create User apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers userEmail: userEmail userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timestamp: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Audit Info for a Task tags: - Audit x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/tasks/{tUUID}/audit_user: get: operationId: getUserFromTask parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: tUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Audit' examples: GetUserFromTask200Example: summary: Default getUserFromTask 200 response x-microcks-default: true value: auditID: 0 targetID: targetID additionalDetails: '{}' taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 target: User userAddress: userAddress apiMethod: GET customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 payload: '{}' action: Create User apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers userEmail: userEmail userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timestamp: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get the User Associated with a Task tags: - Audit x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/telemetry_provider: get: description: 'WARNING: This is a preview API that could change. List All Telemetry Providers' operationId: listAllTelemetryProviders parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/TelemetryProvider' type: array examples: ListAllTelemetryProviders200Example: summary: Default listAllTelemetryProviders 200 response x-microcks-default: true value: - customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 name: name updateTime: 2022-12-12 13:07:18+00:00 config: type: DATA_DOG uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tags: key: tags description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Telemetry Providers tags: - Telemetry Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change. Create Telemetry Provider' operationId: createTelemetry parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/TelemetryProvider' examples: CreateTelemetryRequestExample: summary: Default createTelemetry request x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' name: name updateTime: '2022-12-12T13:07:18+00:00' config: type: DATA_DOG uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tags: key: tags required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelemetryProvider' examples: CreateTelemetry200Example: summary: Default createTelemetry 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 name: name updateTime: 2022-12-12 13:07:18+00:00 config: type: DATA_DOG uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tags: key: tags description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Telemetry Provider tags: - Telemetry Provider x-codegen-request-body-name: providerData x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/telemetry_provider/{intUUID}: delete: description: 'WARNING: This is a preview API that could change. Delete a Telemetry Provider' operationId: deleteTelemetryProvider parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: intUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteTelemetryProvider200Example: summary: Default deleteTelemetryProvider 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Telemetry Provider tags: - Telemetry Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change. Get Telemetry Provider' operationId: getTelemetryProvider parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: intUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelemetryProvider' examples: GetTelemetryProvider200Example: summary: Default getTelemetryProvider 200 response x-microcks-default: true value: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 name: name updateTime: 2022-12-12 13:07:18+00:00 config: type: DATA_DOG uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tags: key: tags description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Telemetry Provider tags: - Telemetry Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector: delete: description: YbaApi Internal. operationId: unregisterUniverse parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: UnregisterUniverse200Example: summary: Default unregisterUniverse 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Unregister Universe from PA Collector tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: YbaApi Internal. operationId: checkRegistered parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/PA Collector universe registration status' description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Check if Universe is Registered with PA Collector tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uUUID}/pa_collector/{paUUID}: put: description: YbaApi Internal. operationId: registerUniverse parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: paUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: advancedObservability schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: RegisterUniverse200Example: summary: Default registerUniverse 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Register Universe with PA Collector tags: - PA Collector x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/last_run: get: description: 'WARNING: This is a preview API that could change.' operationId: getLatestRun parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: GetLatestRun200Example: summary: Default getLatestRun 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Last Performance Advisor Run Details tags: - Performance Advisor x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/perf_advisor_settings: get: description: 'WARNING: This is a preview API that could change.' operationId: getSettings parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerfAdvisorSettingsWithDefaults' examples: GetSettings200Example: summary: Default getSettings 200 response x-microcks-default: true value: defaultSettings: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 universeSettings: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Universe Performance Advisor Settings tags: - Performance Advisor x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: 'WARNING: This is a preview API that could change.' operationId: updateSettings parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PerfAdvisorSettingsFormData' examples: UpdateSettingsRequestExample: summary: Default updateSettings request x-microcks-default: true value: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: UpdateSettings200Example: summary: Default updateSettings 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update Universe Performance Advisor Settings tags: - Performance Advisor x-codegen-request-body-name: PerformanceAdvisorSettingsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/start_manually: post: description: 'WARNING: This is a preview API that could change.' operationId: runPerfAdvisor parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/PerfAdvisorManualRunStatus' examples: RunPerfAdvisor200Example: summary: Default runPerfAdvisor 200 response x-microcks-default: true value: activeRun: scheduleTime: 2022-12-12 13:07:18+00:00 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startTime: 2022-12-12 13:07:18+00:00 endTime: 2022-12-12 13:07:18+00:00 state: PENDING manual: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Start Performance Advisor Run for Universe tags: - Performance Advisor x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/users/{uUUID}/audit_trail: get: operationId: ListOfAudit parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Audit' type: array examples: ListOfAudit200Example: summary: Default ListOfAudit 200 response x-microcks-default: true value: - auditID: 0 targetID: targetID additionalDetails: '{}' taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 target: User userAddress: userAddress apiMethod: GET customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 payload: '{}' action: Create User apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers userEmail: userEmail userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timestamp: 2022-12-12 13:07:18+00:00 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List a User's Audit Entries tags: - Audit x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/grafana_dashboard: get: description: 'WARNING: This is a preview API that could change.' operationId: GrafanaDashboard responses: '200': content: application/json: schema: type: string examples: GrafanaDashboard200Example: summary: Default GrafanaDashboard 200 response x-microcks-default: true value: string description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Grafana Dashboard tags: - Grafana Dashboard x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/logging_config: post: operationId: setLoggingSettings parameters: - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/PlatformLoggingConfig' examples: SetLoggingSettingsRequestExample: summary: Default setLoggingSettings request x-microcks-default: true value: level: ERROR maxHistory: 0 fileNamePrefix: yb-platform- rolloverPattern: rolloverPattern description: Logging config to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PlatformLoggingConfig' examples: SetLoggingSettings200Example: summary: Default setLoggingSettings 200 response x-microcks-default: true value: level: ERROR maxHistory: 0 fileNamePrefix: yb-platform- rolloverPattern: rolloverPattern description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Logging Level tags: - LoggingConfig x-codegen-request-body-name: Logging Config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/prometheus_metrics: get: description: Available since YBA version 2.8.0.0. operationId: MetricsDetail parameters: - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: type: string examples: MetricsDetail200Example: summary: Default MetricsDetail 200 response x-microcks-default: true value: string description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Prometheus Metrics tags: - Metrics x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: apiKeyAuth: description: API token passed as header in: header name: X-AUTH-YW-API-TOKEN type: apiKey schemas: AlertTemplateVariablesFormData: example: variables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: variables: items: $ref: '#/components/schemas/AlertTemplateVariable' maxItems: 2147483647 minItems: 1 type: array example: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - variables type: object AlertDestination: description: Alert notification destination example: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: channels: description: Alert notification channels items: format: uuid type: string maxItems: 2147483647 minItems: 1 type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: description: Default alert notification destination type: boolean example: true name: description: Name maxLength: 63 minLength: 1 type: string example: example-name uuid: description: Destination UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - channels - customerUUID - defaultDestination - name type: object AlertConfiguration: description: Alert configuration example: template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 properties: active: description: Is configured alerts raised or not type: boolean example: true alertCount: format: double type: number example: 1.5 createTime: description: Creation time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: description: Is default destination used for this config type: boolean example: true description: description: Description type: string example: Example description destinationUUID: description: Alert destination UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 durationSec: description: Duration in seconds, while condition is met to raise an alert format: int32 minimum: 0 type: integer example: 60 labels: additionalProperties: type: string description: Labels type: object example: {} maintenanceWindowUuids: description: Maintenance window UUIDs, applied to this alert config items: format: uuid type: string readOnly: true type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: description: Name maxLength: 1000 minLength: 1 type: string example: example-name target: $ref: '#/components/schemas/AlertConfigurationTarget' targetType: description: Target type enum: - PLATFORM - UNIVERSE type: string example: PLATFORM template: description: Template name enum: - REPLICATION_LAG - CLOCK_SKEW - CLOCK_SYNC_CHECK_FAILED - MEMORY_CONSUMPTION - HEALTH_CHECK_ERROR - HEALTH_CHECK_NOTIFICATION_ERROR - UNIVERSE_METRIC_COLLECTION_FAILURE - BACKUP_FAILURE - BACKUP_DELETION_FAILURE - BACKUP_SCHEDULE_FAILURE - INACTIVE_CRON_NODES - ALERT_QUERY_FAILED - ALERT_CONFIG_WRITING_FAILED - ALERT_NOTIFICATION_ERROR - ALERT_NOTIFICATION_CHANNEL_ERROR - NODE_DOWN - NODE_RESTART - NODE_CPU_USAGE - NODE_DISK_USAGE - NODE_SYSTEM_DISK_USAGE - NODE_FILE_DESCRIPTORS_USAGE - NODE_OOM_KILLS - DB_VERSION_MISMATCH - DB_INSTANCE_DOWN - DB_INSTANCE_RESTART - DB_FATAL_LOGS - DB_ERROR_LOGS - DB_CORE_FILES - DB_YSQL_CONNECTION - DB_YCQL_CONNECTION - DB_REDIS_CONNECTION - DB_MEMORY_OVERLOAD - DB_COMPACTION_OVERLOAD - DB_DRIVE_FAILURE - DB_WRITE_READ_TEST_ERROR - DDL_ATOMICITY_CHECK - NODE_TO_NODE_CA_CERT_EXPIRY - NODE_TO_NODE_CERT_EXPIRY - CLIENT_TO_NODE_CA_CERT_EXPIRY - CLIENT_TO_NODE_CERT_EXPIRY - ENCRYPTION_AT_REST_CONFIG_EXPIRY - UNIVERSE_KMS_KEY_STATUS - UNIVERSE_TSERVER_CONNECTIVITY_ERROR - SSH_KEY_EXPIRY - SSH_KEY_ROTATION_FAILURE - PITR_CONFIG_FAILURE - YSQL_OP_AVG_LATENCY - YCQL_OP_AVG_LATENCY - YSQL_OP_P99_LATENCY - YCQL_OP_P99_LATENCY - HIGH_NUM_YSQL_CONNECTIONS - HIGH_NUM_YCQL_CONNECTIONS - HIGH_NUM_YEDIS_CONNECTIONS - YSQL_THROUGHPUT - YCQL_THROUGHPUT - YCQL_MICROSECOND_TIMESTAMPS_DETECTED - MASTER_LEADER_MISSING - MASTER_UNDER_REPLICATED - LEADERLESS_TABLETS - UNDER_REPLICATED_TABLETS - PRIVATE_ACCESS_KEY_STATUS - UNIVERSE_OS_UPDATE_REQUIRED - DB_YCQL_WEB_SERVER_DOWN - DB_YSQL_WEB_SERVER_DOWN - INCREASED_REMOTE_BOOTSTRAPS - TABLET_SERVER_AVG_READ_LATENCY - TABLET_SERVER_AVG_WRITE_LATENCY - REACTOR_DELAYS - RPC_QUEUE_SIZE - LOG_CACHE_SIZE - CACHE_MISS - HA_STANDBY_SYNC - NODE_AGENT_DOWN - NODE_AGENT_MISSING - UNIVERSE_RELEASE_FILES_STATUS - HA_VERSION_MISMATCH - TABLET_PEERS_GUARDRAIL - XCLUSTER_CONFIG_TABLE_BAD_STATE - NODE_CLOCK_DRIFT - UNIVERSE_UNEXPECTED_MASTERS_RUNNING - UNIVERSE_UNEXPECTED_TSERVERS_RUNNING - SAFETIME_LAG - CONTINUOUS_BACKUPS_STATUS - THP_RSS_ISSUE - THP_INCORRECT_SETTINGS - YNP_VERSION_SKEW - CDCSDK_FLUSH_LAG - CDCSDK_EXPIRY - OTEL_LOG_EXPORT_FAILURE - OTEL_METRIC_EXPORT_FAILURE type: string example: REPLICATION_LAG thresholdUnit: description: Threshold unit enum: - STATUS - COUNT - PERCENT - MILLISECOND - SECOND - MINUTE - DAY - MEGABYTE type: string example: STATUS thresholds: additionalProperties: $ref: '#/components/schemas/AlertConfigurationThreshold' description: Thresholds type: object example: {} uuid: description: Configuration UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - active - alertCount - createTime - customerUUID - defaultDestination - description - durationSec - name - target - targetType - template - thresholdUnit - thresholds type: object PerformanceRecommendation: example: new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX properties: customerId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: type: string example: example-entityNames entityType: enum: - UNIVERSE - NODE - TABLE - DATABASE - INDEX type: string example: UNIVERSE id: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: type: boolean example: true new: type: boolean example: true observation: type: string example: example-observation recommendation: type: string example: example-recommendation recommendationInfo: additionalProperties: properties: {} type: object type: object example: {} recommendationPriority: enum: - HIGH - MEDIUM - LOW type: string example: HIGH recommendationState: enum: - OPEN - HIDDEN - RESOLVED type: string example: OPEN recommendationTimestamp: format: int64 type: integer example: 1000 recommendationType: enum: - UNUSED_INDEX - RANGE_SHARDING - QUERY_LOAD_SKEW - CONNECTION_SKEW - CPU_SKEW - CPU_USAGE - REJECTED_CONNECTIONS - HOT_SHARD type: string example: UNUSED_INDEX stateChangeAuditInfoList: items: $ref: '#/components/schemas/StateChangeAuditInfo' type: array example: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customerId - entityNames - entityType - id - isStale - new - observation - recommendation - recommendationInfo - recommendationPriority - recommendationState - recommendationTimestamp - recommendationType - stateChangeAuditInfoList - universeId type: object AlertPagedApiQuery: example: filter: sourceUUIDs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configurationTypes: - PLATFORM - PLATFORM sourceName: sourceName configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: - SEVERE - SEVERE states: - ACTIVE - ACTIVE uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/AlertApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - uuid - createTime - severity - name - sourceName - state type: string example: uuid required: - direction - filter - limit - needTotalCount - offset - sortBy type: object StateChangeAuditInfoPagedQuery: example: filter: customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 recommendationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: id direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/StateChangeAuditInfoFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - id - timestamp type: string example: id required: - direction - filter - limit - needTotalCount - offset - sortBy type: object PerfAdvisorSettingsFormData: example: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 properties: connection_skew_interval_mins: description: Perf advisor connection skew check interval format: int32 minimum: 1 type: integer example: 100 connection_skew_min_connections: description: Perf advisor connection skew min connections format: int32 minimum: 1 type: integer example: 100 connection_skew_threshold_pct: description: Perf advisor connection skew threshold format: double minimum: 1 type: number example: 1.5 cpu_skew_interval_mins: description: Perf advisor cpu skew check interval format: int32 minimum: 1 type: integer example: 100 cpu_skew_min_usage_pct: description: Perf advisor cpu skew min cpu usage format: double minimum: 1 type: number example: 1.5 cpu_skew_threshold_pct: description: Perf advisor cpu skew threshold format: double minimum: 1 type: number example: 1.5 cpu_usage_interval_mins: description: Perf advisor CPU usage check interval format: int32 minimum: 1 type: integer example: 100 cpu_usage_threshold: description: Perf advisor CPU usage threshold format: double minimum: 1 type: number example: 1.5 enabled: description: Enable/disable perf advisor runs for the universe type: boolean example: true hot_shard_interval_mins: description: Perf Advisor hot shard check interval format: int32 minimum: 1 type: integer example: 100 hot_shard_min_node_reads: description: Perf advisor hot shard minimal node reads format: int32 minimum: 1 type: integer example: 100 hot_shard_min_node_writes: description: Perf advisor hot shard minimal node writes format: int32 minimum: 1 type: integer example: 100 hot_shard_read_skew_threshold_pct: description: Perf Advisor hot shard read skew threshold format: double minimum: 1 type: number example: 1.5 hot_shard_write_skew_threshold_pct: description: Perf Advisor hot shard write skew threshold format: double minimum: 1 type: number example: 1.5 query_skew_interval_mins: description: Perf advisor query skew check interval format: int32 minimum: 1 type: integer example: 100 query_skew_min_queries: description: Perf advisor query skew min queries format: int32 minimum: 1 type: integer example: 100 query_skew_threshold_pct: description: Perf advisor query skew threshold format: double minimum: 1 type: number example: 1.5 rejected_conn_interval_mins: description: Perf advisor rejected connections check interval format: int32 minimum: 1 type: integer example: 100 rejected_conn_threshold: description: Perf advisor rejected connections threshold format: int32 minimum: 1 type: integer example: 100 universe_frequency_mins: description: Perf advisor runs frequency, in minutes format: int32 minimum: 5 type: integer example: 100 type: object StateChangeAuditInfoFilter: example: customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 recommendationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: customerId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 recommendationId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customerId - ids - recommendationId - userId type: object AlertConfigurationPagedApiQuery: example: filter: severity: SEVERE template: REPLICATION_LAG destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true destinationType: NO_DESTINATION targetType: PLATFORM target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 offset: 6 needTotalCount: true limit: 0 sortBy: uuid direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/AlertConfigurationApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - uuid - name - active - targetType - target - createTime - template - severity - destination - alertCount type: string example: uuid required: - direction - filter - limit - needTotalCount - offset - sortBy type: object PlatformLoggingConfig: example: level: ERROR maxHistory: 0 fileNamePrefix: yb-platform- rolloverPattern: rolloverPattern properties: fileNamePrefix: description: 'WARNING: This is a preview API that could change. Application log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate application log files as "yb-platform-application.log" instead of "application.log".' example: yb-platform- type: string level: enum: - ERROR - WARN - INFO - DEBUG - TRACE type: string example: ERROR maxHistory: format: int32 minimum: 0 type: integer example: 10 rolloverPattern: type: string example: example-rolloverPattern required: - level - maxHistory - rolloverPattern type: object AlertLabel: example: name: name value: value key: name: name properties: key: $ref: '#/components/schemas/AlertLabelKey' name: type: string example: example-name value: type: string example: example-value required: - key - name - value type: object AlertConfigurationThreshold: description: Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value. example: condition: GREATER_THAN threshold: 1.4658129805029452 properties: condition: description: Threshold condition (greater than, or less than) enum: - GREATER_THAN - LESS_THAN - NOT_EQUAL type: string example: GREATER_THAN threshold: description: Threshold value format: double type: number example: 1.5 required: - condition - threshold type: object PerformanceRecommendationFilter: example: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN properties: createdInstantBefore: format: int64 type: integer example: 1000 customerId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: type: boolean example: true priorities: items: enum: - HIGH - MEDIUM - LOW type: string type: array uniqueItems: true example: - HIGH states: items: enum: - OPEN - HIDDEN - RESOLVED type: string type: array uniqueItems: true example: - OPEN types: items: enum: - UNUSED_INDEX - RANGE_SHARDING - QUERY_LOAD_SKEW - CONNECTION_SKEW - CPU_SKEW - CPU_USAGE - REJECTED_CONNECTIONS - HOT_SHARD type: string type: array uniqueItems: true example: - UNUSED_INDEX universeId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - createdInstantBefore - customerId - ids - isStale - priorities - states - types - universeId type: object AuditLoggingConfig: description: Audit Logging Configuration example: outputToStdout: true maxHistory: 30 fileNamePrefix: yb-platform- rolloverPattern: yyyy-MM-dd outputToFile: true properties: fileNamePrefix: description: 'WARNING: This is a preview API that could change. Audit log file name prefix. Defaults to "". For example, setting this to "yb-platform-" will generate audit log files as "yb-platform-audit.log" instead of "audit.log".' example: yb-platform- type: string maxHistory: description: Max number of days up till which logs are kept example: 30 format: int32 minimum: 0 type: integer outputToFile: description: Flag to enable/disable audit logs output to file type: boolean example: true outputToStdout: description: Flag to enable/disable audit logs output to stdout type: boolean example: true rolloverPattern: description: Rollover Pattern example: yyyy-MM-dd type: string required: - outputToFile - outputToStdout type: object AlertChannel: description: Alert notification channel example: customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: customer_uuid: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: description: Name maxLength: 63 minLength: 1 type: string example: example-name params: $ref: '#/components/schemas/AlertChannelParams' uuid: description: Channel UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customer_uuid - name - params type: object AlertConfigurationTarget: description: Alert target. Set to `all`, or specify one or more target UUIDs. example: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: all: description: Alert applicable to all targets type: boolean example: true uuids: description: Alert target UUIDs items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object PACollector: description: Performance Advisor Collector Model example: apiToken: apiToken customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: metricsPassword metricsUsername: metricsUsername metricsUrl: metricsUrl paApiToken: paApiToken paUrl: paUrl ybaUrl: ybaUrl metricsScrapePeriodSecs: 0 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: apiToken: description: YBA API Token type: string example: REDACTED customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 metricsPassword: description: Metrics API Password type: string example: REDACTED metricsScrapePeriodSecs: description: Metrics Scrape Period Seconds format: int64 type: integer example: 1000 metricsUrl: description: Metrics URL type: string example: https://example.com metricsUsername: description: Metrics API Username type: string example: example-metricsUsername paApiToken: description: PA Collector API Token type: string example: REDACTED paUrl: description: PA Collector URL type: string example: https://example.com uuid: description: PA Collector UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybaUrl: description: YBA URL type: string example: https://example.com required: - apiToken - customerUUID - metricsScrapePeriodSecs - metricsUrl - paUrl - uuid - ybaUrl type: object AlertApiFilter: example: sourceUUIDs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configurationTypes: - PLATFORM - PLATFORM sourceName: sourceName configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: - SEVERE - SEVERE states: - ACTIVE - ACTIVE uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: configurationTypes: description: Alert Configuration Target Types items: enum: - PLATFORM - UNIVERSE type: string type: array uniqueItems: true example: - PLATFORM configurationUuid: description: The uuid of the alert configuration. format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 severities: description: The severity of the alerts. items: enum: - SEVERE - WARNING type: string type: array uniqueItems: true example: - SEVERE sourceName: description: The source name of the alerts. type: string example: example-sourceName sourceUUIDs: description: The source uuids of the alerts. items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 states: description: The state of the alerts. items: enum: - ACTIVE - ACKNOWLEDGED - SUSPENDED - RESOLVED type: string type: array uniqueItems: true example: - ACTIVE uuids: description: The uuids of the alerts. items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object AlertConfigurationTemplate: description: Alert configuration template example: template: REPLICATION_LAG thresholdUnitName: thresholdUnitName thresholdMaxValue: 1.4658129805029452 active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdInteger: true thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 thresholdConditionReadOnly: true thresholdMinValue: 5.962133916683182 thresholdReadOnly: true defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 properties: active: description: Is configured alerts raised or not type: boolean example: true alertCount: format: double type: number example: 1.5 createTime: description: Creation time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: description: Is default destination used for this config type: boolean example: true description: description: Description type: string example: Example description destinationUUID: description: Alert destination UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 durationSec: description: Duration in seconds, while condition is met to raise an alert format: int32 minimum: 0 type: integer example: 60 labels: additionalProperties: type: string description: Labels type: object example: {} maintenanceWindowUuids: description: Maintenance window UUIDs, applied to this alert config items: format: uuid type: string readOnly: true type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: description: Name maxLength: 1000 minLength: 1 type: string example: example-name target: $ref: '#/components/schemas/AlertConfigurationTarget' targetType: description: Target type enum: - PLATFORM - UNIVERSE type: string example: PLATFORM template: description: Template name enum: - REPLICATION_LAG - CLOCK_SKEW - CLOCK_SYNC_CHECK_FAILED - MEMORY_CONSUMPTION - HEALTH_CHECK_ERROR - HEALTH_CHECK_NOTIFICATION_ERROR - UNIVERSE_METRIC_COLLECTION_FAILURE - BACKUP_FAILURE - BACKUP_DELETION_FAILURE - BACKUP_SCHEDULE_FAILURE - INACTIVE_CRON_NODES - ALERT_QUERY_FAILED - ALERT_CONFIG_WRITING_FAILED - ALERT_NOTIFICATION_ERROR - ALERT_NOTIFICATION_CHANNEL_ERROR - NODE_DOWN - NODE_RESTART - NODE_CPU_USAGE - NODE_DISK_USAGE - NODE_SYSTEM_DISK_USAGE - NODE_FILE_DESCRIPTORS_USAGE - NODE_OOM_KILLS - DB_VERSION_MISMATCH - DB_INSTANCE_DOWN - DB_INSTANCE_RESTART - DB_FATAL_LOGS - DB_ERROR_LOGS - DB_CORE_FILES - DB_YSQL_CONNECTION - DB_YCQL_CONNECTION - DB_REDIS_CONNECTION - DB_MEMORY_OVERLOAD - DB_COMPACTION_OVERLOAD - DB_DRIVE_FAILURE - DB_WRITE_READ_TEST_ERROR - DDL_ATOMICITY_CHECK - NODE_TO_NODE_CA_CERT_EXPIRY - NODE_TO_NODE_CERT_EXPIRY - CLIENT_TO_NODE_CA_CERT_EXPIRY - CLIENT_TO_NODE_CERT_EXPIRY - ENCRYPTION_AT_REST_CONFIG_EXPIRY - UNIVERSE_KMS_KEY_STATUS - UNIVERSE_TSERVER_CONNECTIVITY_ERROR - SSH_KEY_EXPIRY - SSH_KEY_ROTATION_FAILURE - PITR_CONFIG_FAILURE - YSQL_OP_AVG_LATENCY - YCQL_OP_AVG_LATENCY - YSQL_OP_P99_LATENCY - YCQL_OP_P99_LATENCY - HIGH_NUM_YSQL_CONNECTIONS - HIGH_NUM_YCQL_CONNECTIONS - HIGH_NUM_YEDIS_CONNECTIONS - YSQL_THROUGHPUT - YCQL_THROUGHPUT - YCQL_MICROSECOND_TIMESTAMPS_DETECTED - MASTER_LEADER_MISSING - MASTER_UNDER_REPLICATED - LEADERLESS_TABLETS - UNDER_REPLICATED_TABLETS - PRIVATE_ACCESS_KEY_STATUS - UNIVERSE_OS_UPDATE_REQUIRED - DB_YCQL_WEB_SERVER_DOWN - DB_YSQL_WEB_SERVER_DOWN - INCREASED_REMOTE_BOOTSTRAPS - TABLET_SERVER_AVG_READ_LATENCY - TABLET_SERVER_AVG_WRITE_LATENCY - REACTOR_DELAYS - RPC_QUEUE_SIZE - LOG_CACHE_SIZE - CACHE_MISS - HA_STANDBY_SYNC - NODE_AGENT_DOWN - NODE_AGENT_MISSING - UNIVERSE_RELEASE_FILES_STATUS - HA_VERSION_MISMATCH - TABLET_PEERS_GUARDRAIL - XCLUSTER_CONFIG_TABLE_BAD_STATE - NODE_CLOCK_DRIFT - UNIVERSE_UNEXPECTED_MASTERS_RUNNING - UNIVERSE_UNEXPECTED_TSERVERS_RUNNING - SAFETIME_LAG - CONTINUOUS_BACKUPS_STATUS - THP_RSS_ISSUE - THP_INCORRECT_SETTINGS - YNP_VERSION_SKEW - CDCSDK_FLUSH_LAG - CDCSDK_EXPIRY - OTEL_LOG_EXPORT_FAILURE - OTEL_METRIC_EXPORT_FAILURE type: string example: REPLICATION_LAG thresholdConditionReadOnly: description: Is alert threshold condition read-only or configurable readOnly: true type: boolean example: true thresholdInteger: description: Is alert threshold integer or floating point readOnly: true type: boolean example: true thresholdMaxValue: description: Alert threshold maximal value format: double readOnly: true type: number example: 1.5 thresholdMinValue: description: Alert threshold minimal value format: double readOnly: true type: number example: 1.5 thresholdReadOnly: description: Is alert threshold read-only or configurable readOnly: true type: boolean example: true thresholdUnit: description: Threshold unit enum: - STATUS - COUNT - PERCENT - MILLISECOND - SECOND - MINUTE - DAY - MEGABYTE type: string example: STATUS thresholdUnitName: description: Threshold unit name readOnly: true type: string example: example-thresholdUnitName thresholds: additionalProperties: $ref: '#/components/schemas/AlertConfigurationThreshold' description: Thresholds type: object example: {} uuid: description: Configuration UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - active - alertCount - createTime - customerUUID - defaultDestination - description - durationSec - name - target - targetType - template - thresholdUnit - thresholds type: object PerfAdvisorManualRunStatus: example: activeRun: scheduleTime: 2022-12-12 13:07:18+00:00 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 startTime: 2022-12-12 13:07:18+00:00 endTime: 2022-12-12 13:07:18+00:00 state: PENDING manual: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 success: true message: message properties: activeRun: $ref: '#/components/schemas/Universe performance advisor status' message: description: API response message. readOnly: true type: string example: Example message success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean example: true type: object PerformanceRecommendationPagedQuery: example: filter: priorities: - HIGH - HIGH types: - UNUSED_INDEX - UNUSED_INDEX customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createdInstantBefore: 0 isStale: true states: - OPEN - OPEN offset: 6 needTotalCount: true limit: 0 sortBy: id direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/PerformanceRecommendationFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - id - recommendationType - recommendationState - recommendationPriority - recommendationTimestamp type: string example: id required: - direction - filter - limit - needTotalCount - offset - sortBy type: object PerformanceRecommendationPagedResponse: example: entities: - new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX - new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX hasPrev: true hasNext: true totalCount: 6 properties: entities: items: $ref: '#/components/schemas/PerformanceRecommendation' type: array example: - new: true recommendationPriority: HIGH entityType: UNIVERSE observation: observation stateChangeAuditInfoList: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 universeId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entityNames: entityNames recommendation: recommendation recommendationTimestamp: 0 recommendationInfo: key: '{}' recommendationState: OPEN customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isStale: true recommendationType: UNUSED_INDEX hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object AlertChannelParams: description: Supertype for channel params for different channel types. discriminator: propertyName: channelType example: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate properties: channelType: description: Channel type enum: - Email - Slack - PagerDuty - WebHook type: string example: Email textTemplate: description: Notification text template type: string example: example-textTemplate titleTemplate: description: Notification title template type: string example: example-titleTemplate type: object AlertPagedResponse: example: entities: - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 - severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 hasPrev: true hasNext: true totalCount: 0 properties: entities: items: $ref: '#/components/schemas/Alert' type: array example: - severity: SEVERE nextNotificationTime: '2022-12-12T13:07:18+00:00' resolvedTime: '2022-12-12T13:07:18+00:00' severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: '2022-12-12T13:07:18+00:00' sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: '2022-12-12T13:07:18+00:00' hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object AlertTemplateVariablesList: example: customVariables: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 systemVariables: - YUGABYTE_ALERT_STATUS - YUGABYTE_ALERT_STATUS properties: customVariables: items: $ref: '#/components/schemas/AlertTemplateVariable' type: array example: - possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 systemVariables: items: enum: - YUGABYTE_ALERT_STATUS - YUGABYTE_ALERT_SEVERITY - YUGABYTE_ALERT_TYPE - YUGABYTE_ALERT_EXPRESSION - YUGABYTE_ALERT_UUID - YUGABYTE_CUSTOMER_CODE - YUGABYTE_CUSTOMER_NAME - YUGABYTE_CUSTOMER_UUID - YUGABYTE_ALERT_SOURCE_UUID - YUGABYTE_ALERT_SOURCE_TYPE - YUGABYTE_ALERT_SOURCE_NAME - YUGABYTE_ALERT_POLICY_TYPE - YUGABYTE_ALERT_POLICY_NAME - YUGABYTE_ALERT_POLICY_UUID - YUGABYTE_ALERT_MESSAGE - YUGABYTE_ALERT_START_TIME - YUGABYTE_ALERT_END_TIME - YUGABYTE_ALERT_CHANNEL_NAME - YUGABYTE_AFFECTED_NODE_NAMES - YUGABYTE_AFFECTED_NODE_ADDRESSES - YUGABYTE_AFFECTED_NODE_IDENTIFIERS - YUGABYTE_ALERT_LABELS_JSON type: string type: array example: - YUGABYTE_ALERT_STATUS required: - customVariables - systemVariables type: object AlertTemplateSettings: description: Alert template settings example: template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels properties: createTime: description: Creation time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: additionalProperties: type: string description: Labels type: object example: {} template: description: Template maxLength: 50 minLength: 1 type: string example: example-template uuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - createTime - customerUUID - template - uuid type: object StateChangeAuditInfoPagedResponse: example: entities: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 hasPrev: true hasNext: true totalCount: 6 properties: entities: items: $ref: '#/components/schemas/StateChangeAuditInfo' type: array example: - new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object AlertConfigurationPagedResponse: example: entities: - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: 2022-12-12 13:07:18+00:00 defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 hasPrev: true hasNext: true totalCount: 0 properties: entities: items: $ref: '#/components/schemas/AlertConfiguration' type: array example: - template: REPLICATION_LAG active: true description: description targetType: PLATFORM maintenanceWindowUuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholds: key: condition: GREATER_THAN threshold: 1.4658129805029452 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 thresholdUnit: STATUS alertCount: 0.8008281904610115 createTime: '2022-12-12T13:07:18+00:00' defaultDestination: true destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name durationSec: 0 hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object TelemetryProviderConfig: description: Telemetry Provider Configuration discriminator: propertyName: type example: type: DATA_DOG properties: type: description: Telemetry Provider Type enum: - DATA_DOG - SPLUNK - AWS_CLOUDWATCH - GCP_CLOUD_MONITORING - LOKI - DYNATRACE - S3 - OTLP type: string example: DATA_DOG type: object AlertLabelKey: example: name: name properties: name: type: string example: example-name required: - name type: object AlertChannelTemplates: description: Alert channel templates example: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 textTemplate: textTemplate type: Email titleTemplate: titleTemplate properties: customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 textTemplate: description: Notification text template type: string example: example-textTemplate titleTemplate: description: Notification title template type: string example: example-titleTemplate type: description: Channel type enum: - Email - Slack - PagerDuty - WebHook type: string example: Email required: - customerUUID - textTemplate - type type: object AlertDestinationFormData: example: channels: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: true name: name properties: channels: items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultDestination: type: boolean example: true name: type: string example: example-name required: - channels - defaultDestination - name type: object Audit: description: Audit logging for requests and responses example: auditID: 0 targetID: targetID additionalDetails: '{}' taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 target: User userAddress: userAddress apiMethod: GET customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 payload: '{}' action: Create User apiCall: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers userEmail: userEmail userUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timestamp: 2022-12-12 13:07:18+00:00 properties: action: description: Action enum: - Set - Create - Edit - Update - Delete - Register - Refresh - Upload - Upgrade - Import - Attach - Pause - Resume - Restart - Abort - Retry - Rollback - Restore - Alter - Drop - Stop - Validate - Acknowledge - SyncXClusterConfig - SyncDrConfig - Failover - Switchover - Login - ApiLogin - Promote - Bootstrap - Configure - UpdateOptions - UpdateLoadBalancerConfig - RefreshPricing - UpgradeSoftware - FinalizeUpgrade - RollbackUpgrade - UpgradeGFlags - CreateTelemetryConfig - DeleteTelemetryConfig - CreatePACollectorConfig - EditPACollectorConfig - DeletePACollectorConfig - PACollectorRegister - PACollectorUnregister - UpgradeKubernetesOverrides - UpgradeCerts - UpgradeTLS - UpgradeVmImage - UpgradeSystemd - RebootUniverse - ResizeNode - AddMetrics - CreateKubernetes - SetupDocker - RetrieveKmsKey - RemoveKmsKeyReferenceHistory - UpsertCustomerFeatures - CreateSelfSignedCert - UpdateEmptyCustomerCertificate - GetRootCertificate - AddClientCertificate - SetDBCredentials - CreateUserInDB - CreateRestrictedUserInDB - DropUserInDB - SetHelm3Compatible - SetBackupFlag - SetUniverseKey - ResetUniverseVersion - ConfigUniverseAlert - ToggleTls - ModifyAuditLogging - ModifyQueryLogging - ConfigureMetricsExport - TlsConfigUpdate - UpdateDiskSize - CreateCluster - DeleteCluster - CreateAllClusters - UpdatePrimaryCluster - UpdateReadOnlyCluster - CreateReadOnlyCluster - DeleteReadOnlyCluster - RunYsqlQuery - BulkImport - CreateBackup - RestoreBackup - CreateSingleTableBackup - CreateMultiTableBackup - CreateBackupSchedule - CreatePitrConfig - UpdatePitrConfig - RestoreSnapshotSchedule - DeletePitrConfig - EditBackupSchedule - StartPeriodicBackup - StopPeriodicBackup - DetachedNodeInstanceAction - NodeInstanceAction - DeleteBackupSchedule - ChangeUserRole - ChangeUserPassword - SetSecurity - GenerateApiToken - ResetSlowQueries - ExternalScriptSchedule - StopScheduledScript - UpdateScheduledScript - CreateInstanceType - DeleteInstanceType - GetUniverseResources - ThirdpartySoftwareUpgrade - CreateTableSpaces - CreateHook - DeleteHook - UpdateHook - CreateHookScope - DeleteHookScope - AddHook - RemoveHook - RotateAccessKey - CreateAndRotateAccessKey - RunHook - RunApiTriggeredHooks - AddNodeAgent - UpdateNodeAgent - DeleteNodeAgent - DisableYbc - UpgradeYbc - InstallYbc - UpgradeYbcGFlags - SetThrottleParams - CreateImageBundle - DeleteImageBundle - EditImageBundle - Detach - RollbackDetach - DeleteAttachDetachMetadata - Unlock - LdapUniverseSync - UpdateProxyConfig - ProvisionUniverseNodes - CloneNamespace - UpdateAdditionalServicesState - KubernetesToggleImmutableYbc - OperatorImportUniverse - RunScript - CreateFileCollection - DownloadFileCollection - DeleteFileCollection example: Create User readOnly: true type: string additionalDetails: description: Additional Details properties: {} readOnly: true type: object example: {} apiCall: description: API call example: /api/v1/customers/<496fdea8-df25-11eb-ba80-0242ac130004>/providers readOnly: true type: string apiMethod: description: API method example: GET readOnly: true type: string auditID: description: Audit UID format: int64 readOnly: true type: integer example: 1000 customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 payload: description: Audit UUID properties: {} readOnly: true type: object example: {} target: description: Target enum: - Session - CloudProvider - Region - AvailabilityZone - CustomerConfig - KMSConfig - Customer - Release - Certificate - CustomCACertificate - Alert - AlertTemplateSettings - AlertTemplateVariables - AlertChannel - AlertChannelTemplates - AlertDestination - MaintenanceWindow - AccessKey - Universe - XClusterConfig - DrConfig - Table - Backup - CustomerTask - NodeInstance - PlatformInstance - Schedule - User - LoggingConfig - RuntimeConfigKey - HAConfig - HABackup - ScheduledScript - SupportBundle - TelemetryProvider - PACollector - GFlags - Hook - HookScope - NodeAgent - CustomerLicense - PerformanceRecommendation - PerformanceAdvisorSettings - PerformanceAdvisorRun - Role - RoleBinding - GroupMapping - JobSchedule - ContinuousBackup - IsolatedBackup example: User readOnly: true type: string targetID: description: Target ID readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: description: Task UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timestamp: description: The task creation time. example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string userAddress: description: User IP Address readOnly: true type: string example: example-userAddress userEmail: description: User Email readOnly: true type: string example: admin@example.com userUUID: description: User UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object AlertTemplateSettingsFormData: example: settings: - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels properties: settings: items: $ref: '#/components/schemas/AlertTemplateSettings' maxItems: 2147483647 minItems: 1 type: array example: - template: template customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: key: labels required: - settings type: object Alert: description: Alert definition. Used to send an alert notification. example: severity: SEVERE nextNotificationTime: 2022-12-12 13:07:18+00:00 resolvedTime: 2022-12-12 13:07:18+00:00 severityIndex: 6 message: message notifiedState: ACTIVE uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: - name: name value: value key: name: name - name: name value: value key: name: name customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 sourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 stateIndex: 1 name: name notificationAttemptTime: 2022-12-12 13:07:18+00:00 sourceName: sourceName state: ACTIVE configurationType: PLATFORM configurationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 notificationsFailed: 0 acknowledgedTime: 2022-12-12 13:07:18+00:00 properties: acknowledgedTime: description: Timestamp at which the alert was acknowledged example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string configurationType: description: Alert configuration type enum: - PLATFORM - UNIVERSE readOnly: true type: string example: PLATFORM configurationUuid: description: Alert configuration UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: description: Alert creation timestamp example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 definitionUuid: description: Alert definition UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 labels: items: $ref: '#/components/schemas/AlertLabel' type: array example: - name: name value: value key: name: name message: description: The alert's message text maxLength: 2147483647 minLength: 1 readOnly: true type: string example: Example message name: description: The alert's name maxLength: 1000 minLength: 1 readOnly: true type: string example: example-name nextNotificationTime: description: Time of the next notification attempt example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string notificationAttemptTime: description: Time of the last notification attempt example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string notificationsFailed: description: Count of failures to send a notification format: int32 readOnly: true type: integer example: 100 notifiedState: description: Alert state in the last-sent notification enum: - ACTIVE - ACKNOWLEDGED - SUSPENDED - RESOLVED readOnly: true type: string example: ACTIVE resolvedTime: description: Timestamp at which the alert was resolved example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string severity: description: Alert configuration severity enum: - SEVERE - WARNING readOnly: true type: string example: SEVERE severityIndex: format: int32 type: integer example: 100 sourceName: description: The source of the alert readOnly: true type: string example: example-sourceName sourceUUID: description: The sourceUUID of the alert format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: description: The alert's state enum: - ACTIVE - ACKNOWLEDGED - SUSPENDED - RESOLVED readOnly: true type: string example: ACTIVE stateIndex: format: int32 type: integer example: 100 uuid: description: Alert UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - configurationType - configurationUuid - createTime - customerUUID - definitionUuid - labels - message - name - severity - severityIndex - sourceName - sourceUUID - state - stateIndex type: object TelemetryProvider: description: Telemetry Provider Model example: customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 name: name updateTime: 2022-12-12 13:07:18+00:00 config: type: DATA_DOG uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tags: key: tags properties: config: $ref: '#/components/schemas/TelemetryProviderConfig' createTime: description: Creation timestamp example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: description: Name type: string example: example-name tags: additionalProperties: type: string description: Extra Tags type: object example: {} updateTime: description: Updation timestamp example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string uuid: description: Telemetry Provider UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - config - customerUUID - name - tags - uuid type: object PerfAdvisorSettingsWithDefaults: example: defaultSettings: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 universeSettings: cpu_skew_interval_mins: 1 hot_shard_interval_mins: 1 query_skew_min_queries: 1 query_skew_interval_mins: 1 cpu_usage_interval_mins: 1 hot_shard_write_skew_threshold_pct: 1.1231513536777256 rejected_conn_interval_mins: 1 connection_skew_threshold_pct: 1.1465812980502945 enabled: true universe_frequency_mins: 5 hot_shard_min_node_writes: 1 hot_shard_read_skew_threshold_pct: 1.7386281948385884 cpu_skew_min_usage_pct: 1.5637376656633328 hot_shard_min_node_reads: 1 cpu_usage_threshold: 1.9301444243932577 cpu_skew_threshold_pct: 1.2302135886934766 query_skew_threshold_pct: 1.684685269835264 rejected_conn_threshold: 1 connection_skew_min_connections: 1 connection_skew_interval_mins: 1 properties: defaultSettings: $ref: '#/components/schemas/PerfAdvisorSettingsFormData' universeSettings: $ref: '#/components/schemas/PerfAdvisorSettingsFormData' type: object AlertChannelFormData: example: name: name params: channelType: Email textTemplate: textTemplate titleTemplate: titleTemplate alertChannelUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: alertChannelUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: type: string example: example-name params: $ref: '#/components/schemas/AlertChannelParams' required: - alertChannelUUID - name - params type: object Universe: example: name: name creation_date: 2024-07-28 01:02:03+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: creation_date: description: Universe creation date example: 2024-07-28 01:02:03+00:00 format: date-time type: string name: type: string example: example-name uuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - name - uuid type: object AlertTemplateVariable: description: Alert template variable example: possibleValues: - possibleValues - possibleValues - possibleValues - possibleValues - possibleValues customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: defaultValue name: name uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 defaultValue: description: Default value maxLength: 2147483647 minLength: 1 type: string example: example-value name: description: Name maxLength: 100 minLength: 1 type: string example: example-name possibleValues: description: Possible values items: type: string maxItems: 2147483647 minItems: 1 type: array uniqueItems: true example: - example-value uuid: description: Variable UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customerUUID - defaultValue - name - possibleValues type: object AlertTemplateApiFilter: example: name: name targetType: PLATFORM properties: name: description: The name of the alert template. type: string example: example-name targetType: description: The target type of the alert template. enum: - PLATFORM - UNIVERSE type: string example: PLATFORM type: object StateChangeAuditInfo: example: new: true fieldName: fieldName customerId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousValue: previousValue userId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updatedValue: updatedValue timestamp: 0 properties: customerId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 fieldName: type: string example: example-fieldName id: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 new: type: boolean example: true previousValue: type: string example: example-value timestamp: format: int64 type: integer example: 1000 updatedValue: type: string example: '2026-05-03' userId: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - customerId - fieldName - id - new - previousValue - timestamp - updatedValue - userId type: object YBPSuccess: example: success: true message: message properties: message: description: API response message. readOnly: true type: string example: Example message success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean example: true type: object AlertConfigurationApiFilter: example: severity: SEVERE template: REPLICATION_LAG destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: name active: true destinationType: NO_DESTINATION targetType: PLATFORM target: all: true uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuids: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: active: description: Whether the alert configuration is active. type: boolean example: true destinationType: description: 'The destination type of the alert configuration. ' enum: - NO_DESTINATION - DEFAULT_DESTINATION - SELECTED_DESTINATION type: string example: NO_DESTINATION destinationUuid: description: 'The destination uuid of the alert configuration. ' format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 name: description: The name of the alert configuration. type: string example: example-name severity: description: The severity of the alert configuration. enum: - SEVERE - WARNING type: string example: SEVERE target: $ref: '#/components/schemas/AlertConfigurationTarget' targetType: description: The target type of the alert configuration. enum: - PLATFORM - UNIVERSE type: string example: PLATFORM template: description: The template of the alert configuration. enum: - REPLICATION_LAG - CLOCK_SKEW - CLOCK_SYNC_CHECK_FAILED - MEMORY_CONSUMPTION - HEALTH_CHECK_ERROR - HEALTH_CHECK_NOTIFICATION_ERROR - UNIVERSE_METRIC_COLLECTION_FAILURE - BACKUP_FAILURE - BACKUP_DELETION_FAILURE - BACKUP_SCHEDULE_FAILURE - INACTIVE_CRON_NODES - ALERT_QUERY_FAILED - ALERT_CONFIG_WRITING_FAILED - ALERT_NOTIFICATION_ERROR - ALERT_NOTIFICATION_CHANNEL_ERROR - NODE_DOWN - NODE_RESTART - NODE_CPU_USAGE - NODE_DISK_USAGE - NODE_SYSTEM_DISK_USAGE - NODE_FILE_DESCRIPTORS_USAGE - NODE_OOM_KILLS - DB_VERSION_MISMATCH - DB_INSTANCE_DOWN - DB_INSTANCE_RESTART - DB_FATAL_LOGS - DB_ERROR_LOGS - DB_CORE_FILES - DB_YSQL_CONNECTION - DB_YCQL_CONNECTION - DB_REDIS_CONNECTION - DB_MEMORY_OVERLOAD - DB_COMPACTION_OVERLOAD - DB_DRIVE_FAILURE - DB_WRITE_READ_TEST_ERROR - DDL_ATOMICITY_CHECK - NODE_TO_NODE_CA_CERT_EXPIRY - NODE_TO_NODE_CERT_EXPIRY - CLIENT_TO_NODE_CA_CERT_EXPIRY - CLIENT_TO_NODE_CERT_EXPIRY - ENCRYPTION_AT_REST_CONFIG_EXPIRY - UNIVERSE_KMS_KEY_STATUS - UNIVERSE_TSERVER_CONNECTIVITY_ERROR - SSH_KEY_EXPIRY - SSH_KEY_ROTATION_FAILURE - PITR_CONFIG_FAILURE - YSQL_OP_AVG_LATENCY - YCQL_OP_AVG_LATENCY - YSQL_OP_P99_LATENCY - YCQL_OP_P99_LATENCY - HIGH_NUM_YSQL_CONNECTIONS - HIGH_NUM_YCQL_CONNECTIONS - HIGH_NUM_YEDIS_CONNECTIONS - YSQL_THROUGHPUT - YCQL_THROUGHPUT - YCQL_MICROSECOND_TIMESTAMPS_DETECTED - MASTER_LEADER_MISSING - MASTER_UNDER_REPLICATED - LEADERLESS_TABLETS - UNDER_REPLICATED_TABLETS - PRIVATE_ACCESS_KEY_STATUS - UNIVERSE_OS_UPDATE_REQUIRED - DB_YCQL_WEB_SERVER_DOWN - DB_YSQL_WEB_SERVER_DOWN - INCREASED_REMOTE_BOOTSTRAPS - TABLET_SERVER_AVG_READ_LATENCY - TABLET_SERVER_AVG_WRITE_LATENCY - REACTOR_DELAYS - RPC_QUEUE_SIZE - LOG_CACHE_SIZE - CACHE_MISS - HA_STANDBY_SYNC - NODE_AGENT_DOWN - NODE_AGENT_MISSING - UNIVERSE_RELEASE_FILES_STATUS - HA_VERSION_MISMATCH - TABLET_PEERS_GUARDRAIL - XCLUSTER_CONFIG_TABLE_BAD_STATE - NODE_CLOCK_DRIFT - UNIVERSE_UNEXPECTED_MASTERS_RUNNING - UNIVERSE_UNEXPECTED_TSERVERS_RUNNING - SAFETIME_LAG - CONTINUOUS_BACKUPS_STATUS - THP_RSS_ISSUE - THP_INCORRECT_SETTINGS - YNP_VERSION_SKEW - CDCSDK_FLUSH_LAG - CDCSDK_EXPIRY - OTEL_LOG_EXPORT_FAILURE - OTEL_METRIC_EXPORT_FAILURE type: string example: REPLICATION_LAG uuids: description: The uuids of the alert configurations. items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object