-
Notifications
You must be signed in to change notification settings - Fork 9
/
lists.yaml
350 lines (350 loc) · 9.78 KB
/
lists.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
openapi: 3.0.0
info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Lists
version: v3
servers:
- url: https://{hostname}/etp-config/v3
x-akamai:
auth-type: EDGE_GRID
file-path: lists.yaml
paths:
/akamai-lists:
parameters:
- $ref: parameters/includeNonConfigurable.yaml
get:
operationId: get-akamai-lists
summary: List all Akamai built-in security lists
tags:
- Akamai built-in security lists
description: |
Returns a list of all available Akamai built-in Lists.
responses:
200:
description: |
Successful response.
content:
application/json:
example:
$ref: examples/akamai-security-lists-200.json
schema:
$ref: schemas/akamaiSecurityLists.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
/configs/{configId}/clear-dns-cache:
parameters:
- $ref: parameters/configId-path.yaml
post:
operationId: post-dns-cache
summary: Clear the DNS cache
tags:
- DNS cache
description: |
Clears the DNS cache for the specified domain.
requestBody:
content:
application/json:
example:
$ref: examples/clear-dns-cache-200.json
schema:
$ref: schemas/clearDnsCache.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
/configs/{configId}/lists:
parameters:
- $ref: parameters/configId-path.yaml
- $ref: parameters/includeDeleted.yaml
- $ref: parameters/includeSpecialEntities.yaml
- $ref: parameters/onlyWithGrantedAccess.yaml
post:
operationId: post-list
summary: Create a list
tags:
- Lists
description: |
Creates a new list.
parameters:
- $ref: parameters/configId-path.yaml
requestBody:
required: true
content:
application/json:
example:
$ref: examples/create-list-body.json
schema:
$ref: schemas/listCreate.yaml
responses:
200:
description: |
Successful response.
headers:
Location:
$ref: headers/location-header.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
409:
$ref: errors/conflict-409.yaml
get:
operationId: get-lists
summary: List all lists
tags:
- Lists
description: |
Returns a list of all available custom security lists.
responses:
200:
description: |
Successful response.
content:
application/json:
example:
$ref: examples/list-retrieve-all-200.json
schema:
$ref: schemas/listRetrieveAll.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
/configs/{configId}/lists/quota:
parameters:
- $ref: parameters/configId-path.yaml
get:
operationId: get-lists-quota
summary: List global list quotas
tags:
- Lists
description: |
Returns the remaining list item quota for all lists globally.
responses:
200:
description: |
Successful response.
content:
application/json:
example:
$ref: examples/list-get-global-quota-200.json
schema:
$ref: schemas/listGetGlobalQuota.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
/configs/{configId}/lists/{listId}:
parameters:
- $ref: parameters/listId-path.yaml
- $ref: parameters/configId-path.yaml
- $ref: parameters/includeDeleted.yaml
get:
operationId: get-list
summary: Get details of a list
tags:
- Lists
description: |
Returns the details of a specific list.
responses:
200:
description: |
Successful response.
headers:
ETag:
$ref: headers/ETag.yaml
content:
application/json:
example:
$ref: examples/list-retrieve-specific-200.json
schema:
$ref: schemas/listRetrieveSpecific.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
put:
operationId: put-config-list
summary: Update a list
tags:
- Lists
description: |
Modifies list properties and all items for a specific list. Full update only.
parameters:
- $ref: headers/if-match-header.yaml
requestBody:
required: true
content:
application/json:
example:
$ref: examples/list-retrieve-specific-200.json
schema:
$ref: schemas/listRetrieveSpecific.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
412:
$ref: errors/precondition-failed-412.yaml
delete:
operationId: delete-config-list
summary: Remove a list
tags:
- Lists
description: |
Deletes a specific list.
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
409:
$ref: errors/conflict-409.yaml
412:
$ref: errors/precondition-failed-412.yaml
/configs/{configId}/lists/{listId}/items:
parameters:
- $ref: parameters/configId-path.yaml
- $ref: parameters/listId-path.yaml
get:
operationId: get-config-lists-items
summary: Search in a list
tags:
- Lists
description: |
Filters items in a list by search parameters.
parameters:
- $ref: parameters/confidence.yaml
- $ref: parameters/numItemsPerPage.yaml
- $ref: parameters/page.yaml
- $ref: parameters/search.yaml
- $ref: parameters/type.yaml
responses:
200:
description: |
Successful response.
headers:
ETag:
$ref: headers/ETag.yaml
content:
application/json:
example:
$ref: examples/list-retrieve-by-search-200.json
schema:
$ref: schemas/listRetrieveBySearch.yaml
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
put:
operationId: put-config-lists-items
summary: Modify list items
tags:
- Lists
description: |
Updates list items (overwrite).
parameters:
- $ref: headers/if-match-header.yaml
requestBody:
required: true
content:
application/json:
example:
$ref: examples/set-list-items-content-body.json
schema:
$ref: schemas/listSetItemsAll.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
412:
$ref: errors/precondition-failed-412.yaml
patch:
operationId: patch-config-list
summary: Patch a list
tags:
- Lists
description: |
Modifies individual list items entries. Add or delete only.
requestBody:
required: true
content:
application/json:
example:
$ref: examples/list-modify-items-body.json
schema:
$ref: schemas/listModifyItemsContent.yaml
responses:
200:
description: |
Successful response.
400:
$ref: errors/validation-error-400.yaml
401:
$ref: errors/unauthorized-401.yaml
403:
$ref: errors/InsufficientPermissions-403.yaml
404:
$ref: errors/not-found-404.yaml
409:
$ref: errors/conflict-409.yaml
412:
$ref: errors/precondition-failed-412.yaml