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: splunk_sdk/action/v1beta2/openapi.yaml
+43-19Lines changed: 43 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
1
components:
2
2
parameters:
3
3
ActionName:
4
-
description: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
4
+
description: The name of the action as one or more identifier strings separated
5
+
by periods. Each identifier string consists of lowercase letters, digits,
6
+
and underscores, and cannot start with a digit.
5
7
in: path
6
8
name: action_name
7
9
required: true
@@ -67,7 +69,8 @@ components:
67
69
ActionImmutable:
68
70
properties:
69
71
createdAt:
70
-
description: The date and time this action template was created (ISO-8601 date/time with zone).
72
+
description: The date and time this action template was created (ISO-8601
73
+
date/time with zone).
71
74
format: date-time
72
75
readOnly: true
73
76
type: string
@@ -78,11 +81,14 @@ components:
78
81
kind:
79
82
$ref: '#/components/schemas/ActionKind'
80
83
name:
81
-
description: The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
84
+
description: The name of the action, as one or more identifier strings separated
85
+
by periods. Each identifier string consists of lowercase letters, digits,
description: The date and time this action template was updated (ISO-8601 date/time with zone).
90
+
description: The date and time this action template was updated (ISO-8601
91
+
date/time with zone).
86
92
format: date-time
87
93
readOnly: true
88
94
type: string
@@ -145,26 +151,34 @@ components:
145
151
type: string
146
152
type: array
147
153
body:
148
-
description: HTML content to send as the body of the email. You can use a template in this field.
154
+
description: HTML content to send as the body of the email. You can use
155
+
a template in this field.
149
156
example: <html><body>Hello, this is my test email.</body></html>
150
157
type: string
151
158
bodyPlainText:
152
-
description: Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.
159
+
description: Optional text to send as the text/plain part of the email.
160
+
If this field is not set for an email action, the Action service converts
161
+
the value from the body field to text and sends that as the text/plain
162
+
part when invoking the action. You can use a template in this field.
153
163
example: Hello, this is my test email.
154
164
type: string
155
165
fromName:
156
-
description: Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.
166
+
description: Optional text providing a human-friendly name for the sender.
167
+
Must be less than or equal to 81 characters. You can use a template in
168
+
this field.
157
169
type: string
158
170
members:
159
-
description: An array of tenant member names, whose profile email addresses will be included as recipients.
171
+
description: An array of tenant member names, whose profile email addresses
172
+
will be included as recipients.
160
173
items:
161
174
type: string
162
175
type: array
163
176
subject:
164
177
description: The subject of the email. You can use a template in this field.
165
178
type: string
166
179
title:
167
-
description: A human-readable title for the action. Must be less than or equal to 128 characters.
180
+
description: A human-readable title for the action. Must be less than or
181
+
equal to 128 characters.
168
182
type: string
169
183
type: object
170
184
PublicWebhookKey:
@@ -211,7 +225,8 @@ components:
211
225
type: string
212
226
type: array
213
227
members:
214
-
description: An array of tenant member names, whose profile email addresses will be included as recipients.
228
+
description: An array of tenant member names, whose profile email addresses
229
+
will be included as recipients.
215
230
items:
216
231
type: string
217
232
type: array
@@ -225,7 +240,8 @@ components:
225
240
readOnly: true
226
241
type: string
227
242
id:
228
-
description: A unique identifier for this trigger event. Generated from a hash of all recursively-sorted event field values.
243
+
description: A unique identifier for this trigger event. Generated from
244
+
a hash of all recursively-sorted event field values.
229
245
readOnly: true
230
246
type: string
231
247
kind:
@@ -246,7 +262,8 @@ components:
246
262
type: string
247
263
ttlSeconds:
248
264
default: 3600
249
-
description: A time to live (TTL), expressed as seconds after createdAt, after which the trigger event will no longer be acted upon.
265
+
description: A time to live (TTL), expressed as seconds after createdAt,
266
+
after which the trigger event will no longer be acted upon.
250
267
format: int32
251
268
minimum: 1
252
269
type: integer
@@ -266,7 +283,8 @@ components:
266
283
WebhookActionMutable:
267
284
properties:
268
285
title:
269
-
description: A human-readable title for the action. Must be less than 128 characters.
286
+
description: A human-readable title for the action. Must be less than 128
287
+
characters.
270
288
type: string
271
289
webhookHeaders:
272
290
additionalProperties:
@@ -514,14 +532,17 @@ paths:
514
532
application/json:
515
533
schema:
516
534
$ref: '#/components/schemas/TriggerEvent'
517
-
description: The action payload, which should include values for any templated fields.
535
+
description: The action payload, which should include values for any templated
536
+
fields.
518
537
required: true
519
538
responses:
520
539
"201":
521
540
description: The trigger event was received successfully.
522
541
headers:
523
542
Location:
524
-
description: The URL of the run status, with the format "{tenant}/action/v1beta2/actions/{action_name}/status/{status_id}". Send a GET request to this URL to check the status, which will be available for 4 days.
543
+
description: The URL of the run status, with the format "{tenant}/action/v1beta2/actions/{action_name}/status/{status_id}".
544
+
Send a GET request to this URL to check the status, which will be
545
+
available for 4 days.
525
546
schema:
526
547
type: string
527
548
"400":
@@ -580,7 +601,8 @@ paths:
580
601
schema:
581
602
$ref: '#/components/schemas/ServiceError'
582
603
description: An error occurred.
583
-
summary: Returns the status of an action that was invoked. The status is available for 4 days after the last status change.
604
+
summary: Returns the status of an action that was invoked. The status is available
605
+
for 4 days after the last status change.
584
606
tags:
585
607
- Actions
586
608
x-authz-scope: action.actions.read
@@ -625,7 +647,8 @@ paths:
625
647
schema:
626
648
$ref: '#/components/schemas/ServiceError'
627
649
description: An error occurred.
628
-
summary: Returns the status details of the invoked email action. The status is available for 4 days after the last status change.
650
+
summary: Returns the status details of the invoked email action. The status
651
+
is available for 4 days after the last status change.
629
652
tags:
630
653
- Actions
631
654
x-authz-scope: action.actions.read
@@ -652,9 +675,10 @@ paths:
652
675
schema:
653
676
$ref: '#/components/schemas/ServiceError'
654
677
description: An error occurred.
655
-
summary: Returns an array of one or two webhook keys. The first key is active. The second key, if present, is expired.
678
+
summary: Returns an array of one or two webhook keys. The first key is active.
679
+
The second key, if present, is expired.
656
680
tags:
657
681
- Webhook Keys
658
682
x-auth-required: false
659
683
660
-
# Retrieved from scp-openapi commit 75824d71791e0b0bdf66dbcce7dd9dc1e7061407 path: action/v1beta2/openapi.yaml
684
+
# Retrieved from scp-openapi commit 3e10ab186559df6d0a5211cf734514cd53d79779 path: action/v1beta2/openapi.yaml
0 commit comments