You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: generated/alerting/api/openapi.yaml
+214-4Lines changed: 214 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1065,6 +1065,106 @@ paths:
1065
1065
summary: Unmutes an alert instance.
1066
1066
tags:
1067
1067
- alerting
1068
+
/api/alerting/maintenance_window:
1069
+
post:
1070
+
description: |
1071
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
To delete a rule, you must have `all` privileges for the appropriate Kibana features. WARNING: After you delete a maintenance window, you cannot recover it.
description: Indicates an invalid schema or parameters.
1153
+
"403":
1154
+
content:
1155
+
application/json:
1156
+
schema:
1157
+
$ref: '#/components/schemas/403_response'
1158
+
description: Indicates that this call is forbidden.
1159
+
"404":
1160
+
content:
1161
+
application/json:
1162
+
schema:
1163
+
$ref: '#/components/schemas/404_response'
1164
+
description: Object is not found.
1165
+
summary: Get maintenance window details
1166
+
tags:
1167
+
- alerting
1068
1168
components:
1069
1169
examples:
1070
1170
create_es_query_esql_rule_request:
@@ -2148,6 +2248,15 @@ components:
2148
2248
required: true
2149
2249
schema: {}
2150
2250
style: simple
2251
+
maintenance_window_id:
2252
+
description: An identifier for the maintenance window.
2253
+
explode: false
2254
+
in: path
2255
+
name: maintenanceWindowId
2256
+
required: true
2257
+
schema:
2258
+
example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74
2259
+
style: simple
2151
2260
schemas:
2152
2261
filter:
2153
2262
description: A filter written in Elasticsearch Query Domain Specific Language
@@ -2652,10 +2761,8 @@ components:
2652
2761
description: Indicates whether the field is required.
2653
2762
type: boolean
2654
2763
scaling_factor:
2655
-
description: "The scaling factor to use when encoding values. This property\
2656
-
\ is applicable when `type` is `scaled_float`. Values will be multiplied\
2657
-
\ by this factor at index time and rounded to the closest long value.\
2658
-
\ \n"
2764
+
description: |
2765
+
The scaling factor to use when encoding values. This property is applicable when `type` is `scaled_float`. Values will be multiplied by this factor at index time and rounded to the closest long value.
2659
2766
type: integer
2660
2767
type:
2661
2768
description: Specifies the data type for the field.
@@ -2767,6 +2874,109 @@ components:
2767
2874
nullable: true
2768
2875
type: string
2769
2876
title: Legacy alert response properties
2877
+
create_maintenance_window_request:
2878
+
description: The properties used to create a maintenance window.
2879
+
properties:
2880
+
title:
2881
+
description: |
2882
+
The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a maintenance window.
2883
+
type: string
2884
+
enabled:
2885
+
description: Indicates whether the maintenance window is currently enabled.
2886
+
example: true
2887
+
type: boolean
2888
+
duration:
2889
+
type: number
2890
+
start:
2891
+
description: An ISO date.
2892
+
type: string
2893
+
required:
2894
+
- duration
2895
+
- start
2896
+
- title
2897
+
title: Create maintenance window request body properties
2898
+
maintenance_window_response_properties:
2899
+
example:
2900
+
duration: 0.8008281904610115
2901
+
updated_at: 2022-12-05T23:36:58.284Z
2902
+
start: start
2903
+
updated_by: elastic
2904
+
created_at: 2022-12-05T23:36:58.284Z
2905
+
id: b530fed0-74f5-11ed-9801-35303b735aef
2906
+
title: ESQuery Maintenance Window
2907
+
created_by: elastic
2908
+
enabled: true
2909
+
status: running
2910
+
properties:
2911
+
id:
2912
+
description: The identifier for the maintenance window.
2913
+
example: b530fed0-74f5-11ed-9801-35303b735aef
2914
+
type: string
2915
+
title:
2916
+
description: The name of the maintenance window.
2917
+
example: ESQuery Maintenance Window
2918
+
type: string
2919
+
start:
2920
+
description: The start date of the maintenance window.
2921
+
type: string
2922
+
duration:
2923
+
description: The duration of the maintenance window.
2924
+
type: number
2925
+
enabled:
2926
+
description: Indicates whether the maintenance window is currently enabled.
2927
+
example: true
2928
+
type: boolean
2929
+
created_by:
2930
+
description: The identifier for the user that created the maintenance window.
2931
+
example: elastic
2932
+
type: string
2933
+
nullable: true
2934
+
created_at:
2935
+
description: The date and time in which the maintenance window was created.
2936
+
example: 2022-12-05T23:36:58.284Z
2937
+
format: date-time
2938
+
type: string
2939
+
updated_by:
2940
+
description: The identifier for the user that updated this maintenance window
2941
+
most recently.
2942
+
example: elastic
2943
+
type: string
2944
+
nullable: true
2945
+
updated_at:
2946
+
description: The date and time that the maintenance window was updated most
2947
+
recently.
2948
+
example: 2022-12-05T23:36:58.284Z
2949
+
type: string
2950
+
status:
2951
+
description: "The status of the maintenance window. One of the following\
2952
+
\ values `running`, `upcoming`, `finished` or `archived`."
0 commit comments