mihari 5.4.1 → 5.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/frontend/package-lock.json +145 -146
- data/frontend/package.json +8 -8
- data/frontend/src/swagger.yaml +306 -272
- data/lib/mihari/cli/alert.rb +11 -0
- data/lib/mihari/cli/main.rb +6 -1
- data/lib/mihari/commands/alert.rb +42 -0
- data/lib/mihari/commands/rule.rb +2 -2
- data/lib/mihari/commands/search.rb +20 -59
- data/lib/mihari/config.rb +1 -1
- data/lib/mihari/emitters/base.rb +1 -1
- data/lib/mihari/emitters/database.rb +2 -2
- data/lib/mihari/errors.rb +23 -2
- data/lib/mihari/http.rb +7 -1
- data/lib/mihari/schemas/alert.rb +14 -0
- data/lib/mihari/services/alert_proxy.rb +106 -0
- data/lib/mihari/services/alert_runner.rb +22 -0
- data/lib/mihari/services/{rule.rb → rule_proxy.rb} +10 -6
- data/lib/mihari/services/rule_runner.rb +49 -0
- data/lib/mihari/version.rb +1 -1
- data/lib/mihari/web/endpoints/alerts.rb +22 -0
- data/lib/mihari/web/endpoints/rules.rb +8 -8
- data/lib/mihari/web/public/assets/{index-61dc587c.js → index-4d7eda9f.js} +1 -1
- data/lib/mihari/web/public/index.html +1 -1
- data/lib/mihari/web/public/redoc-static.html +29 -27
- data/lib/mihari.rb +6 -1
- data/mihari.gemspec +2 -3
- metadata +14 -23
- data/Steepfile +0 -31
|
@@ -50,11 +50,11 @@ data-styled.g14[id="sc-jlZhew"]{content:"kbdRLs,"}/*!sc*/
|
|
|
50
50
|
.kZTEzX{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
|
|
51
51
|
.hWEnWx{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
|
|
52
52
|
.hWEnWx polygon{fill:#1d8127;}/*!sc*/
|
|
53
|
-
.cSkZlF{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
|
|
54
|
-
.cSkZlF polygon{fill:#d41f1c;}/*!sc*/
|
|
55
53
|
.iVFMLx{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(0);-ms-transform:rotateZ(0);transform:rotateZ(0);}/*!sc*/
|
|
56
54
|
.iVFMLx polygon{fill:white;}/*!sc*/
|
|
57
|
-
|
|
55
|
+
.cSkZlF{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;-webkit-transition:-webkit-transform 0.2s ease-out;-webkit-transition:transform 0.2s ease-out;transition:transform 0.2s ease-out;-webkit-transform:rotateZ(-90deg);-ms-transform:rotateZ(-90deg);transform:rotateZ(-90deg);}/*!sc*/
|
|
56
|
+
.cSkZlF polygon{fill:#d41f1c;}/*!sc*/
|
|
57
|
+
data-styled.g15[id="sc-cwHptR"]{content:"kZTEzX,hWEnWx,iVFMLx,cSkZlF,"}/*!sc*/
|
|
58
58
|
.hZbWKe{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
|
|
59
59
|
@media screen and (max-width:50rem){.hZbWKe{display:block;overflow:hidden;}}/*!sc*/
|
|
60
60
|
tr:first-of-type > .sc-dLMFU,tr.last > .hZbWKe{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
|
|
@@ -292,11 +292,11 @@ data-styled.g113[id="sc-EgOXT"]{content:"fVtHyw,"}/*!sc*/
|
|
|
292
292
|
.jtLmPa ..sc-EgOXT{color:#ffffff;}/*!sc*/
|
|
293
293
|
.jtLmPa:focus{box-shadow:inset 0 2px 2px rgba(0,0,0,0.45),0 2px 0 rgba(128,128,128,0.25);}/*!sc*/
|
|
294
294
|
data-styled.g114[id="sc-eZYNyq"]{content:"jtLmPa,"}/*!sc*/
|
|
295
|
-
.
|
|
295
|
+
.hJzVsN{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
296
296
|
.cTwxAL{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
297
|
+
.fBnwuX{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
297
298
|
.lenzxa{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
|
298
|
-
|
|
299
|
-
data-styled.g115[id="sc-dlWCHZ"]{content:"fBnwuX,cTwxAL,lenzxa,hJzVsN,"}/*!sc*/
|
|
299
|
+
data-styled.g115[id="sc-dlWCHZ"]{content:"hJzVsN,cTwxAL,fBnwuX,lenzxa,"}/*!sc*/
|
|
300
300
|
.jKfuBO{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0px 0px 6px rgba(0,0,0,0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;-webkit-transition:all 0.25s ease;transition:all 0.25s ease;visibility:hidden;-webkit-transform:translateY(-50%) scaleY(0);-ms-transform:translateY(-50%) scaleY(0);transform:translateY(-50%) scaleY(0);}/*!sc*/
|
|
301
301
|
data-styled.g116[id="sc-hHOBiw"]{content:"jKfuBO,"}/*!sc*/
|
|
302
302
|
.fTEywo{padding:10px;}/*!sc*/
|
|
@@ -348,7 +348,7 @@ data-styled.g138[id="sc-dxcDKg"]{content:"eajCCh,"}/*!sc*/
|
|
|
348
348
|
|
|
349
349
|
<body>
|
|
350
350
|
|
|
351
|
-
<div id="redoc"><div class="sc-lnPyaJ eJNCiX redoc-wrap"><div class="sc-eBHhsj dhHelK menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iapWAC cNIbYM"><svg class="sc-dxcDKg eajCCh search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-kqGoIF eLSrIr search-input"/></div><div class="sc-kOHTFB IVbWU scrollbar-container undefined"><ul class="sc-bpUBKd bpycMf" role="menu"><li data-item-id="tag/alerts" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="alerts" class="sc-kbousE jSTdPd">alerts</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/alerts/paths/~1api~1alerts
|
|
351
|
+
<div id="redoc"><div class="sc-lnPyaJ eJNCiX redoc-wrap"><div class="sc-eBHhsj dhHelK menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-iapWAC cNIbYM"><svg class="sc-dxcDKg eajCCh search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input type="text" value="" placeholder="Search..." aria-label="Search" class="sc-kqGoIF eLSrIr search-input"/></div><div class="sc-kOHTFB IVbWU scrollbar-container undefined"><ul class="sc-bpUBKd bpycMf" role="menu"><li data-item-id="tag/alerts" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="alerts" class="sc-kbousE jSTdPd">alerts</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/alerts/paths/~1api~1alerts/post" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="post" class="sc-kYxDKI kjICpR operation-type post">post</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Create an alert</span></label></li><li data-item-id="tag/alerts/paths/~1api~1alerts/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Search alerts</span></label></li><li data-item-id="tag/alerts/paths/~1api~1alerts~1{id}/delete" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="delete" class="sc-kYxDKI kjICpR operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Delete an alert</span></label></li></ul></li><li data-item-id="tag/artifacts" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="artifacts" class="sc-kbousE jSTdPd">artifacts</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/artifacts/paths/~1api~1artifacts~1{id}/delete" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="delete" class="sc-kYxDKI kjICpR operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Delete an artifact</span></label></li><li data-item-id="tag/artifacts/paths/~1api~1artifacts~1{id}/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get an artifact</span></label></li><li data-item-id="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Enrich an artifact</span></label></li></ul></li><li data-item-id="tag/configs" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="configs" class="sc-kbousE jSTdPd">configs</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/configs/paths/~1api~1configs/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get configs</span></label></li></ul></li><li data-item-id="tag/ip_addresses" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="ip_addresses" class="sc-kbousE jSTdPd">ip_addresses</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get an IP address</span></label></li></ul></li><li data-item-id="tag/rules" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="rules" class="sc-kbousE jSTdPd">rules</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/rules/paths/~1api~1rules~1{id}/delete" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="delete" class="sc-kYxDKI kjICpR operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Delete a rule</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules~1{id}/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get a rule</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules/put" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="put" class="sc-kYxDKI kjICpR operation-type put">put</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Update a rule</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules/post" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="post" class="sc-kYxDKI kjICpR operation-type post">post</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Create a rule</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Search rules</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules~1{id}~1run/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Run a rule</span></label></li><li data-item-id="tag/rules/paths/~1api~1rules~1ids/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get rule IDs</span></label></li></ul></li><li data-item-id="tag/tags" class="sc-eyvILC fbjDYy"><label type="tag" role="menuitem" class="sc-gfoqjT hlXHtc -depth1"><span title="tags" class="sc-kbousE jSTdPd">tags</span><svg class="sc-cwHptR kZTEzX" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-bpUBKd eXvsLO"><li data-item-id="tag/tags/paths/~1api~1tags~1{name}/delete" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="delete" class="sc-kYxDKI kjICpR operation-type delete">del</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Delete a tag</span></label></li><li data-item-id="tag/tags/paths/~1api~1tags/get" class="sc-eyvILC fbjDYy"><label role="menuitem" class="sc-gfoqjT ioZqbe -depth2"><span type="get" class="sc-kYxDKI kjICpR operation-type get">get</span><span width="calc(100% - 38px)" class="sc-kbousE dlJfXA">Get tags</span></label></li></ul></li></ul><div class="sc-sLsrZ iSibdF"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-iXzfSG eSbAVe"><div class="sc-dPZUQH iHNVTh"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
|
352
352
|
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
|
353
353
|
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
|
354
354
|
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
|
@@ -367,56 +367,58 @@ data-styled.g138[id="sc-dxcDKg"]{content:"eajCCh,"}/*!sc*/
|
|
|
367
367
|
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
|
368
368
|
-104.0616 -231.873,-231.248 z
|
|
369
369
|
" fill="currentColor"></path></g></svg></div></div><div class="sc-eulNck iEaKWZ api-content"><div class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx api-info"><h1 class="sc-imWYAI sc-gmgFlS cILgPb crFmld">Mihari API<!-- --> <span>(<!-- -->0.0.1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kMkxaj iQWvAY">Download</a></p><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-summary"></div><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO" data-role="redoc-description"></div></div></div></div><div id="tag/alerts" data-section-id="tag/alerts" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/alerts" aria-label="tag/alerts"></a>alerts</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about alerts</p>
|
|
370
|
-
</div></div></div><div id="tag/alerts/paths/~1api~1alerts
|
|
371
|
-
</div></div><
|
|
372
|
-
</span></button></div><div><button class="sc-
|
|
373
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/alerts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/alerts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-2" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-3" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-3" aria-labelledby="react-tabs-2"></div></div></div></div></div></div><div id="tag/alerts/paths/~1api~1alerts/get" data-section-id="tag/alerts/paths/~1api~1alerts/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/alerts/paths/~1api~1alerts/get" aria-label="tag/alerts/paths/~1api~1alerts/get"></a>Search alerts<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Search alerts</p>
|
|
370
|
+
</div></div></div><div id="tag/alerts/paths/~1api~1alerts/post" data-section-id="tag/alerts/paths/~1api~1alerts/post" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/alerts/paths/~1api~1alerts/post" aria-label="tag/alerts/paths/~1api~1alerts/post"></a>Create an alert<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Create an alert</p>
|
|
371
|
+
</div></div><h5 class="sc-dAlyuH jbQuod">Request Body schema: <span class="sc-eBMEME cPThXn">application/json</span></h5><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><table class="sc-dAbbOL ccPhmY"><tbody><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="ruleId"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">ruleId</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="artifacts"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">artifacts</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV">Array of </span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">strings</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">201<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Create an alert</p>
|
|
372
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="post" class="sc-dlWCHZ hJzVsN http-verb post">post</span><span class="sc-EgOXT fVtHyw">/api/alerts</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/alerts</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-0" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-1" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-1" aria-labelledby="react-tabs-0"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ruleId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-2" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-3" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-3" aria-labelledby="react-tabs-2"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ruleId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/alerts/paths/~1api~1alerts/get" data-section-id="tag/alerts/paths/~1api~1alerts/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/alerts/paths/~1api~1alerts/get" aria-label="tag/alerts/paths/~1api~1alerts/get"></a>Search alerts<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Search alerts</p>
|
|
374
373
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">query<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="page"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">page</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-cfxfcM ecSUzn"> <!-- -->Default:<!-- --> </span> <span class="sc-cfxfcM sc-fxwrCY ecSUzn cdJsux">1</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="limit"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">limit</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-cfxfcM ecSUzn"> <!-- -->Default:<!-- --> </span> <span class="sc-cfxfcM sc-fxwrCY ecSUzn cdJsux">10</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="artifact"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">artifact</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="rule_id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">rule_id</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="tag"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">tag</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="fromAt"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">fromAt</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->date-time<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="toAt"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">toAt</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->date-time<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Search alerts</p>
|
|
375
374
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
376
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/alerts</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/alerts</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-4" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-5" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-6" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-7" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-5" aria-labelledby="react-tabs-4"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"alerts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ruleId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currentPage"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pageSize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-7" aria-labelledby="react-tabs-6"></div></div></div></div></div></div><div id="tag/
|
|
375
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/alerts</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/alerts</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-4" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-5" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-6" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-7" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-5" aria-labelledby="react-tabs-4"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"alerts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"ruleId"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"artifacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dataType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currentPage"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pageSize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-7" aria-labelledby="react-tabs-6"></div></div></div></div></div></div><div id="tag/alerts/paths/~1api~1alerts~1{id}/delete" data-section-id="tag/alerts/paths/~1api~1alerts~1{id}/delete" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/alerts/paths/~1api~1alerts~1{id}/delete" aria-label="tag/alerts/paths/~1api~1alerts~1{id}/delete"></a>Delete an alert<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Delete an alert</p>
|
|
376
|
+
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Delete an alert</p>
|
|
377
|
+
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
378
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/alerts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/alerts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-8" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-9" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-10" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-11" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-9" aria-labelledby="react-tabs-8"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-11" aria-labelledby="react-tabs-10"></div></div></div></div></div></div><div id="tag/artifacts" data-section-id="tag/artifacts" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/artifacts" aria-label="tag/artifacts"></a>artifacts</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about artifacts</p>
|
|
377
379
|
</div></div></div><div id="tag/artifacts/paths/~1api~1artifacts~1{id}/delete" data-section-id="tag/artifacts/paths/~1api~1artifacts~1{id}/delete" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/artifacts/paths/~1api~1artifacts~1{id}/delete" aria-label="tag/artifacts/paths/~1api~1artifacts~1{id}/delete"></a>Delete an artifact<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Delete an artifact</p>
|
|
378
380
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Delete an artifact</p>
|
|
379
381
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
380
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
382
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-12" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-13" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-14" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-15" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-15" aria-labelledby="react-tabs-14"></div></div></div></div></div></div><div id="tag/artifacts/paths/~1api~1artifacts~1{id}/get" data-section-id="tag/artifacts/paths/~1api~1artifacts~1{id}/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/artifacts/paths/~1api~1artifacts~1{id}/get" aria-label="tag/artifacts/paths/~1api~1artifacts~1{id}/get"></a>Get an artifact<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get an artifact</p>
|
|
381
383
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get an artifact</p>
|
|
382
384
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
383
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-12" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-13" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-14" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-15" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-13" aria-labelledby="react-tabs-12"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dataType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autonomousSystem"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"asn"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"geolocation"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"country"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"countryCode"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whoisRecord"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"domain"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiresOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"registrar"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"contacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reverseDnsNames"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsRecords"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"resource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cpe"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ports"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"port"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-15" aria-labelledby="react-tabs-14"></div></div></div></div></div></div><div id="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" data-section-id="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" aria-label="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get"></a>Enrich an artifact<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Enrich an artifact</p>
|
|
385
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-16" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-17" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-18" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-19" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-17" aria-labelledby="react-tabs-16"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dataType"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"source"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"autonomousSystem"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"asn"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"geolocation"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"country"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"countryCode"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"whoisRecord"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"domain"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expiresOn"</span>: <span class="token string">"2019-08-24"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"registrar"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"contacts"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"reverseDnsNames"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dnsRecords"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"resource"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"value"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"cpes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"cpe"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"ports"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"port"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-19" aria-labelledby="react-tabs-18"></div></div></div></div></div></div><div id="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" data-section-id="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get" aria-label="tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get"></a>Enrich an artifact<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Enrich an artifact</p>
|
|
384
386
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Enrich an artifact</p>
|
|
385
387
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
386
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}/enrich</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}/enrich</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
388
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/artifacts/{id}/enrich</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/artifacts/{id}/enrich</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-20" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-21" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-22" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-23" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-21" aria-labelledby="react-tabs-20"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-23" aria-labelledby="react-tabs-22"></div></div></div></div></div></div><div id="tag/configs" data-section-id="tag/configs" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/configs" aria-label="tag/configs"></a>configs</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about configs</p>
|
|
387
389
|
</div></div></div><div id="tag/configs/paths/~1api~1configs/get" data-section-id="tag/configs/paths/~1api~1configs/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/configs/paths/~1api~1configs/get" aria-label="tag/configs/paths/~1api~1configs/get"></a>Get configs<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get configs</p>
|
|
388
390
|
</div></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get configs</p>
|
|
389
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/configs</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/configs</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
391
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/configs</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/configs</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-24" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-25" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-25" aria-labelledby="react-tabs-24"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"values"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"isConfigured"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/ip_addresses" data-section-id="tag/ip_addresses" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/ip_addresses" aria-label="tag/ip_addresses"></a>ip_addresses</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about ip_addresses</p>
|
|
390
392
|
</div></div></div><div id="tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get" data-section-id="tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get" aria-label="tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get"></a>Get an IP address<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get an IP address</p>
|
|
391
393
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="ip"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">ip</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get an IP address</p>
|
|
392
394
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
393
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/ip_addresses/{ip}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/ip_addresses/{ip}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
395
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/ip_addresses/{ip}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/ip_addresses/{ip}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-26" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-27" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-28" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-29" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-27" aria-labelledby="react-tabs-26"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"ip"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"countryCode"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"hostname"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"loc"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"asn"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-29" aria-labelledby="react-tabs-28"></div></div></div></div></div></div><div id="tag/rules" data-section-id="tag/rules" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/rules" aria-label="tag/rules"></a>rules</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about rules</p>
|
|
394
396
|
</div></div></div><div id="tag/rules/paths/~1api~1rules~1{id}/delete" data-section-id="tag/rules/paths/~1api~1rules~1{id}/delete" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules~1{id}/delete" aria-label="tag/rules/paths/~1api~1rules~1{id}/delete"></a>Delete a rule<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Delete a rule</p>
|
|
395
397
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Delete a rule</p>
|
|
396
398
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
397
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
399
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-30" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-31" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-32" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-33" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-31" aria-labelledby="react-tabs-30"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-33" aria-labelledby="react-tabs-32"></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules~1{id}/get" data-section-id="tag/rules/paths/~1api~1rules~1{id}/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules~1{id}/get" aria-label="tag/rules/paths/~1api~1rules~1{id}/get"></a>Get a rule<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get a rule</p>
|
|
398
400
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get a rule</p>
|
|
399
401
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
400
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
402
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-34" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-35" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-36" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-37" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-35" aria-labelledby="react-tabs-34"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"yaml"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-37" aria-labelledby="react-tabs-36"></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules/put" data-section-id="tag/rules/paths/~1api~1rules/put" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules/put" aria-label="tag/rules/paths/~1api~1rules/put"></a>Update a rule<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Update a rule</p>
|
|
401
403
|
</div></div><h5 class="sc-dAlyuH jbQuod">Request Body schema: <span class="sc-eBMEME cPThXn">application/json</span></h5><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><table class="sc-dAbbOL ccPhmY"><tbody><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="yaml"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">yaml</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Update a rule</p>
|
|
402
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="put" class="sc-dlWCHZ lenzxa http-verb put">put</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
404
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="put" class="sc-dlWCHZ lenzxa http-verb put">put</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-38" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-39" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-39" aria-labelledby="react-tabs-38"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"yaml"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-40" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-41" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-41" aria-labelledby="react-tabs-40"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"yaml"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules/post" data-section-id="tag/rules/paths/~1api~1rules/post" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules/post" aria-label="tag/rules/paths/~1api~1rules/post"></a>Create a rule<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Create a rule</p>
|
|
403
405
|
</div></div><h5 class="sc-dAlyuH jbQuod">Request Body schema: <span class="sc-eBMEME cPThXn">application/json</span></h5><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"></div><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="yaml"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">yaml</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">201<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Create a rule</p>
|
|
404
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="post" class="sc-dlWCHZ hJzVsN http-verb post">post</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
406
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="post" class="sc-dlWCHZ hJzVsN http-verb post">post</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Request samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-42" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-43" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-43" aria-labelledby="react-tabs-42"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"yaml"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-44" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-45" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-45" aria-labelledby="react-tabs-44"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"yaml"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules/get" data-section-id="tag/rules/paths/~1api~1rules/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules/get" aria-label="tag/rules/paths/~1api~1rules/get"></a>Search rules<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Search rules</p>
|
|
405
407
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">query<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="page"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">page</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-cfxfcM ecSUzn"> <!-- -->Default:<!-- --> </span> <span class="sc-cfxfcM sc-fxwrCY ecSUzn cdJsux">1</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="limit"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">limit</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">integer</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->int32<!-- -->><!-- --> </span></div><div><span class="sc-cfxfcM ecSUzn"> <!-- -->Default:<!-- --> </span> <span class="sc-cfxfcM sc-fxwrCY ecSUzn cdJsux">10</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="title"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">title</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="description"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">description</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="tag"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">tag</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class=""><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="fromAt"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">fromAt</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->date-time<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="toAt"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">toAt</span></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb"> <!-- --><<!-- -->date-time<!-- -->><!-- --> </span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Search rules</p>
|
|
406
408
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
407
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
409
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-48" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-49" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-47" aria-labelledby="react-tabs-46"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"rules"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"yaml"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"createdAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updatedAt"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"currentPage"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pageSize"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-49" aria-labelledby="react-tabs-48"></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules~1{id}~1run/get" data-section-id="tag/rules/paths/~1api~1rules~1{id}~1run/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules~1{id}~1run/get" aria-label="tag/rules/paths/~1api~1rules~1{id}~1run/get"></a>Run a rule<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Run a rule</p>
|
|
408
410
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="id"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">id</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Run a rule</p>
|
|
409
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}/run</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}/run</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
411
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/{id}/run</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/{id}/run</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-50" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-51" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-51" aria-labelledby="react-tabs-50"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/rules/paths/~1api~1rules~1ids/get" data-section-id="tag/rules/paths/~1api~1rules~1ids/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/rules/paths/~1api~1rules~1ids/get" aria-label="tag/rules/paths/~1api~1rules~1ids/get"></a>Get rule IDs<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get Rule IDs</p>
|
|
410
412
|
</div></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get Rule IDs</p>
|
|
411
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/ids</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/ids</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
413
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/rules/ids</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/rules/ids</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-52" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-53" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-53" aria-labelledby="react-tabs-52"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"ruleIds"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/tags" data-section-id="tag/tags" class="sc-dcJsrY bBkGhy"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h1 class="sc-imWYAI cILgPb"><a class="sc-jlZhew kbdRLs" href="#tag/tags" aria-label="tag/tags"></a>tags</h1></div></div><div class="sc-fqkvVR diIqQJ"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO redoc-markdown "><p>Operations about tags</p>
|
|
412
414
|
</div></div></div><div id="tag/tags/paths/~1api~1tags~1{name}/delete" data-section-id="tag/tags/paths/~1api~1tags~1{name}/delete" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/tags/paths/~1api~1tags~1{name}/delete" aria-label="tag/tags/paths/~1api~1tags~1{name}/delete"></a>Delete a tag<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Delete a tag</p>
|
|
413
415
|
</div></div><div><h5 class="sc-dAlyuH jbQuod">path<!-- --> Parameters</h5><table class="sc-dAbbOL ccPhmY"><tbody><tr class="last "><td class="sc-dLMFU sc-eldPxv hZbWKe jXkfaY" kind="field" title="name"><span class="sc-gFqAkR eRqgPI"></span><span class="property-name">name</span><div class="sc-iHbSHJ sc-klVQfs jJvHFQ SbUMR">required</div></td><td class="sc-fPXMVe bAXEAa"><div><div><span class="sc-cfxfcM sc-gFAWRd ecSUzn bbMYmV"></span><span class="sc-cfxfcM sc-gmPhUn ecSUzn hUewpb">string</span></div> <div><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Delete a tag</p>
|
|
414
416
|
</span></button></div><div><button class="sc-gdyeKB eQaxld"><svg class="sc-cwHptR cSkZlF" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">404<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Not found</p>
|
|
415
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/tags/{name}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/tags/{name}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
417
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="delete" class="sc-dlWCHZ fBnwuX http-verb delete">delete</span><span class="sc-EgOXT fVtHyw">/api/tags/{name}</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/tags/{name}</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-54" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-55" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="react-tabs-56" aria-selected="false" aria-disabled="false" aria-controls="react-tabs-57" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-55" aria-labelledby="react-tabs-54"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="react-tabs-57" aria-labelledby="react-tabs-56"></div></div></div></div></div></div><div id="tag/tags/paths/~1api~1tags/get" data-section-id="tag/tags/paths/~1api~1tags/get" class="sc-dcJsrY cqVkUp"><div class="sc-kAyceB hBQWIZ"><div class="sc-fqkvVR oJKYx"><h2 class="sc-jXbUNg fWnwAh"><a class="sc-jlZhew kbdRLs" href="#tag/tags/paths/~1api~1tags/get" aria-label="tag/tags/paths/~1api~1tags/get"></a>Get tags<!-- --> </h2><div class="sc-bVVIoq icSMtY"><div class="sc-eeDRCY sc-dCFHLb gTGgei dJWFsO"><p>Get tags</p>
|
|
416
418
|
</div></div><div><h3 class="sc-fMMURN egoxtT">Responses</h3><div><button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dSIIpw bpEYcE">200<!-- --> </strong><span class="sc-fhzFiK gducij"><p>Get tags</p>
|
|
417
|
-
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/tags</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/tags</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-
|
|
419
|
+
</span></button></div></div></div><div class="sc-iGgWBj sc-gsFSXq ibAZSi eDeKjd"><div class="sc-iEXKAA jQGZcv"><button class="sc-eZYNyq jtLmPa"><span type="get" class="sc-dlWCHZ cTwxAL http-verb get">get</span><span class="sc-EgOXT fVtHyw">/api/tags</span><svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-hHOBiw jKfuBO"><div class="sc-kWtpeL fTEywo"><div class="sc-eeDRCY sc-dCFHLb gTGgei dwkgVY"></div><div tabindex="0" role="button"><div class="sc-ecPEgm kxVUfn"><span></span>/api/tags</div></div></div></div></div><div><h3 class="sc-kpDqfm eBBgSB"> <!-- -->Response samples<!-- --> </h3><div class="sc-bXCLTC dHowgL" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-58" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-59" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-59" aria-labelledby="react-tabs-58"><div><div class="sc-fBWQRz hEqesG"><span class="sc-bbSZdi hzinCC">Content type</span><div class="sc-fjvvzt dMqZRk">application/json</div></div><div class="sc-hCPjZK gKuDgt"><div class="sc-fXSgeo HQFTv"><div class="sc-koXPp efufqz"><button><div class="sc-jxOSlx ebiVIa">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-eeDRCY gTGgei sc-JrDLc hMzemk"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"tags"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-dExYaf gZbfaQ"></div></div></div>
|
|
418
420
|
<script>
|
|
419
|
-
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Mihari API","version":"0.0.1"},"tags":[{"name":"alerts","description":"Operations about alerts"},{"name":"artifacts","description":"Operations about artifacts"},{"name":"configs","description":"Operations about configs"},{"name":"ip_addresses","description":"Operations about ip_addresses"},{"name":"rules","description":"Operations about rules"},{"name":"tags","description":"Operations about tags"}],"paths":{"/api/alerts/{id}":{"delete":{"summary":"Delete an alert","description":"Delete an alert","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Delete an alert","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["alerts"]}},"/api/alerts":{"get":{"summary":"Search alerts","description":"Search alerts","parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"in":"query","name":"artifact","required":false,"schema":{"type":"string"}},{"in":"query","name":"rule_id","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"in":"query","name":"fromAt","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"toAt","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Search alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_AlertsWithPagination"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["alerts"]}},"/api/artifacts/{id}":{"delete":{"summary":"Delete an artifact","description":"Delete an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Delete an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]},"get":{"summary":"Get an artifact","description":"Get an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Get an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Artifact"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]}},"/api/artifacts/{id}/enrich":{"get":{"summary":"Enrich an artifact","description":"Enrich an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Enrich an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]}},"/api/configs":{"get":{"summary":"Get configs","description":"Get configs","responses":{"200":{"description":"Get configs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Config"}}}}}},"tags":["configs"]}},"/api/ip_addresses/{ip}":{"get":{"summary":"Get an IP address","description":"Get an IP address","parameters":[{"in":"path","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get an IP address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_IPAddress"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["ip_addresses"]}},"/api/rules/{id}":{"delete":{"summary":"Delete a rule","description":"Delete a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]},"get":{"summary":"Get a rule","description":"Get a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules":{"put":{"summary":"Update a rule","description":"Update a rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putApiRules"}}},"required":true},"responses":{"200":{"description":"Update a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}}},"tags":["rules"]},"post":{"summary":"Create a rule","description":"Create a rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postApiRules"}}},"required":true},"responses":{"201":{"description":"Create a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}}},"tags":["rules"]},"get":{"summary":"Search rules","description":"Search rules","parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"in":"query","name":"title","required":false,"schema":{"type":"string"}},{"in":"query","name":"description","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"in":"query","name":"fromAt","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"toAt","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Search rules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_RulesWithPagination"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules/{id}/run":{"get":{"summary":"Run a rule","description":"Run a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Run a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules/ids":{"get":{"summary":"Get rule IDs","description":"Get Rule IDs","responses":{"200":{"description":"Get Rule IDs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_RuleIDs"}}}}}},"tags":["rules"]}},"/api/tags/{name}":{"delete":{"summary":"Delete a tag","description":"Delete a tag","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete a tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["tags"]}},"/api/tags":{"get":{"summary":"Get tags","description":"Get tags","responses":{"200":{"description":"Get tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tags"}}}}}},"tags":["tags"]}}},"components":{"schemas":{"Mihari_Entities_Message":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"description":"Mihari_Entities_Message model"},"Mihari_Entities_AlertsWithPagination":{"type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Alert"}},"total":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"required":["alerts","total","currentPage","pageSize"],"description":"Mihari_Entities_AlertsWithPagination model"},"Mihari_Entities_Alert":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"ruleId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_BaseArtifact"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tag"}}},"required":["id","ruleId","createdAt","tags"]},"Mihari_Entities_BaseArtifact":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"data":{"type":"string"},"dataType":{"type":"string"},"source":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":["id","data","dataType","source"]},"Mihari_Entities_Tag":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Mihari_Entities_Artifact":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"data":{"type":"string"},"dataType":{"type":"string"},"source":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"},"autonomousSystem":{"$ref":"#/components/schemas/Mihari_Entities_AutonomousSystem"},"geolocation":{"$ref":"#/components/schemas/Mihari_Entities_Geolocation"},"whoisRecord":{"$ref":"#/components/schemas/Mihari_Entities_WhoisRecord"},"reverseDnsNames":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_ReverseDnsName"}},"dnsRecords":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_DnsRecord"}},"cpes":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_CPE"}},"ports":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Port"}}},"required":["id","data","dataType","source"],"description":"Mihari_Entities_Artifact model"},"Mihari_Entities_AutonomousSystem":{"type":"object","properties":{"asn":{"type":"integer","format":"int32"}},"required":["asn"]},"Mihari_Entities_Geolocation":{"type":"object","properties":{"country":{"type":"string"},"countryCode":{"type":"string"}},"required":["country","countryCode"]},"Mihari_Entities_WhoisRecord":{"type":"object","properties":{"domain":{"type":"string"},"createdOn":{"type":"string","format":"date"},"updatedOn":{"type":"string","format":"date"},"expiresOn":{"type":"string","format":"date"},"registrar":{"type":"object"},"contacts":{"type":"array","items":{"type":"object"}}},"required":["domain","contacts"]},"Mihari_Entities_ReverseDnsName":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Mihari_Entities_DnsRecord":{"type":"object","properties":{"resource":{"type":"string"},"value":{"type":"string"}},"required":["resource","value"]},"Mihari_Entities_CPE":{"type":"object","properties":{"cpe":{"type":"string"}},"required":["cpe"]},"Mihari_Entities_Port":{"type":"object","properties":{"port":{"type":"integer","format":"int32"}},"required":["port"]},"Mihari_Entities_Config":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"isConfigured":{"type":"boolean"}},"required":["name","type","values","isConfigured"],"description":"Mihari_Entities_Config model"},"Mihari_Entities_IPAddress":{"type":"object","properties":{"ip":{"type":"string"},"countryCode":{"type":"string"},"hostname":{"type":"string"},"loc":{"type":"string"},"asn":{"type":"integer","format":"int32"}},"required":["ip","countryCode","loc"],"description":"Mihari_Entities_IPAddress model"},"putApiRules":{"type":"object","properties":{"id":{"type":"string"},"yaml":{"type":"string"}},"required":["id","yaml"],"description":"Update a rule"},"Mihari_Entities_Rule":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"yaml":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tag"}}},"required":["id","title","description","yaml","createdAt","updatedAt","tags"],"description":"Mihari_Entities_Rule model"},"postApiRules":{"type":"object","properties":{"yaml":{"type":"string"}},"required":["yaml"],"description":"Create a rule"},"Mihari_Entities_RulesWithPagination":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}},"total":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"required":["rules","total","currentPage","pageSize"],"description":"Mihari_Entities_RulesWithPagination model"},"Mihari_Entities_RuleIDs":{"type":"object","properties":{"ruleIds":{"type":"string"}},"required":["ruleIds"],"description":"Mihari_Entities_RuleIDs model"},"Mihari_Entities_Tags":{"type":"object","properties":{"tags":{"type":"string"}},"required":["tags"],"description":"Mihari_Entities_Tags model"}}}}},"searchIndex":{"store":["tag/alerts","tag/alerts/paths/~1api~1alerts~1{id}/delete","tag/alerts/paths/~1api~1alerts/get","tag/artifacts","tag/artifacts/paths/~1api~1artifacts~1{id}/delete","tag/artifacts/paths/~1api~1artifacts~1{id}/get","tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get","tag/configs","tag/configs/paths/~1api~1configs/get","tag/ip_addresses","tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get","tag/rules","tag/rules/paths/~1api~1rules~1{id}/delete","tag/rules/paths/~1api~1rules~1{id}/get","tag/rules/paths/~1api~1rules/put","tag/rules/paths/~1api~1rules/post","tag/rules/paths/~1api~1rules/get","tag/rules/paths/~1api~1rules~1{id}~1run/get","tag/rules/paths/~1api~1rules~1ids/get","tag/tags","tag/tags/paths/~1api~1tags~1{name}/delete","tag/tags/paths/~1api~1tags/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.477]],["description/0",[0,1.385,1,1.385]],["title/1",[0,1.128,2,0.889]],["description/1",[0,1.178,2,0.928,3,2.544]],["title/2",[0,1.128,4,1.456]],["description/2",[0,1.178,4,1.52,5,2.544]],["title/3",[6,1.163]],["description/3",[1,1.385,6,1.091]],["title/4",[2,0.889,6,0.889]],["description/4",[2,0.928,6,0.928,7,2.068]],["title/5",[6,1.163]],["description/5",[6,1.091,7,2.432]],["title/6",[6,0.889,8,1.981]],["description/6",[6,0.928,8,2.068,9,2.544]],["title/7",[10,1.907]],["description/7",[1,1.385,10,1.788]],["title/8",[10,1.907]],["description/8",[10,1.788,11,2.992]],["title/9",[12,2.594]],["description/9",[1,1.385,12,2.432]],["title/10",[13,1.981,14,1.981]],["description/10",[13,2.068,14,2.068,15,2.544]],["title/11",[16,0.388]],["description/11",[1,1.385,16,0.364]],["title/12",[2,0.889,16,0.296]],["description/12",[2,0.928,16,0.31,17,2.068]],["title/13",[16,0.388]],["description/13",[16,0.364,17,2.432]],["title/14",[16,0.296,18,1.981]],["description/14",[16,0.31,18,2.068,19,1.755]],["title/15",[16,0.296,20,1.981]],["description/15",[16,0.31,19,1.755,20,2.068]],["title/16",[4,1.456,16,0.296]],["description/16",[4,1.52,16,0.31,19,1.755]],["title/17",[16,0.296,21,1.981]],["description/17",[16,0.31,21,2.068,22,2.544]],["title/18",[16,0.296,23,1.981]],["description/18",[16,0.31,23,2.068,24,2.544]],["title/19",[25,1.477]],["description/19",[1,1.385,25,1.385]],["title/20",[2,0.889,25,1.128]],["description/20",[2,0.928,25,1.178,26,2.544]],["title/21",[25,1.477]],["description/21",[25,1.385,27,2.992]]],"invertedIndex":[["address",{"_index":14,"title":{"10":{}},"description":{"10":{}}}],["alert",{"_index":0,"title":{"0":{},"1":{},"2":{}},"description":{"0":{},"1":{},"2":{}}}],["api/alert",{"_index":5,"title":{},"description":{"2":{}}}],["api/alerts/{id",{"_index":3,"title":{},"description":{"1":{}}}],["api/artifacts/{id",{"_index":7,"title":{},"description":{"4":{},"5":{}}}],["api/artifacts/{id}/enrich",{"_index":9,"title":{},"description":{"6":{}}}],["api/config",{"_index":11,"title":{},"description":{"8":{}}}],["api/ip_addresses/{ip",{"_index":15,"title":{},"description":{"10":{}}}],["api/rul",{"_index":19,"title":{},"description":{"14":{},"15":{},"16":{}}}],["api/rules/id",{"_index":24,"title":{},"description":{"18":{}}}],["api/rules/{id",{"_index":17,"title":{},"description":{"12":{},"13":{}}}],["api/rules/{id}/run",{"_index":22,"title":{},"description":{"17":{}}}],["api/tag",{"_index":27,"title":{},"description":{"21":{}}}],["api/tags/{nam",{"_index":26,"title":{},"description":{"20":{}}}],["artifact",{"_index":6,"title":{"3":{},"4":{},"5":{},"6":{}},"description":{"3":{},"4":{},"5":{},"6":{}}}],["config",{"_index":10,"title":{"7":{},"8":{}},"description":{"7":{},"8":{}}}],["creat",{"_index":20,"title":{"15":{}},"description":{"15":{}}}],["delet",{"_index":2,"title":{"1":{},"4":{},"12":{},"20":{}},"description":{"1":{},"4":{},"12":{},"20":{}}}],["enrich",{"_index":8,"title":{"6":{}},"description":{"6":{}}}],["id",{"_index":23,"title":{"18":{}},"description":{"18":{}}}],["ip",{"_index":13,"title":{"10":{}},"description":{"10":{}}}],["ip_address",{"_index":12,"title":{"9":{}},"description":{"9":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"3":{},"7":{},"9":{},"11":{},"19":{}}}],["rule",{"_index":16,"title":{"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{}},"description":{"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{}}}],["run",{"_index":21,"title":{"17":{}},"description":{"17":{}}}],["search",{"_index":4,"title":{"2":{},"16":{}},"description":{"2":{},"16":{}}}],["tag",{"_index":25,"title":{"19":{},"20":{},"21":{}},"description":{"19":{},"20":{},"21":{}}}],["updat",{"_index":18,"title":{"14":{}},"description":{"14":{}}}]],"pipeline":[]}},"options":{}};
|
|
421
|
+
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Mihari API","version":"0.0.1"},"tags":[{"name":"alerts","description":"Operations about alerts"},{"name":"artifacts","description":"Operations about artifacts"},{"name":"configs","description":"Operations about configs"},{"name":"ip_addresses","description":"Operations about ip_addresses"},{"name":"rules","description":"Operations about rules"},{"name":"tags","description":"Operations about tags"}],"paths":{"/api/alerts":{"post":{"summary":"Create an alert","description":"Create an alert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postApiAlerts"}}},"required":true},"responses":{"201":{"description":"Create an alert","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Alert"}}}}},"tags":["alerts"]},"get":{"summary":"Search alerts","description":"Search alerts","parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"in":"query","name":"artifact","required":false,"schema":{"type":"string"}},{"in":"query","name":"rule_id","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"in":"query","name":"fromAt","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"toAt","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Search alerts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_AlertsWithPagination"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["alerts"]}},"/api/alerts/{id}":{"delete":{"summary":"Delete an alert","description":"Delete an alert","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Delete an alert","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["alerts"]}},"/api/artifacts/{id}":{"delete":{"summary":"Delete an artifact","description":"Delete an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Delete an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]},"get":{"summary":"Get an artifact","description":"Get an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Get an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Artifact"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]}},"/api/artifacts/{id}/enrich":{"get":{"summary":"Enrich an artifact","description":"Enrich an artifact","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Enrich an artifact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["artifacts"]}},"/api/configs":{"get":{"summary":"Get configs","description":"Get configs","responses":{"200":{"description":"Get configs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Config"}}}}}},"tags":["configs"]}},"/api/ip_addresses/{ip}":{"get":{"summary":"Get an IP address","description":"Get an IP address","parameters":[{"in":"path","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get an IP address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_IPAddress"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["ip_addresses"]}},"/api/rules/{id}":{"delete":{"summary":"Delete a rule","description":"Delete a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]},"get":{"summary":"Get a rule","description":"Get a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules":{"put":{"summary":"Update a rule","description":"Update a rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putApiRules"}}},"required":true},"responses":{"200":{"description":"Update a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}}},"tags":["rules"]},"post":{"summary":"Create a rule","description":"Create a rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postApiRules"}}},"required":true},"responses":{"201":{"description":"Create a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}}}}},"tags":["rules"]},"get":{"summary":"Search rules","description":"Search rules","parameters":[{"in":"query","name":"page","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"in":"query","name":"title","required":false,"schema":{"type":"string"}},{"in":"query","name":"description","required":false,"schema":{"type":"string"}},{"in":"query","name":"tag","required":false,"schema":{"type":"string"}},{"in":"query","name":"fromAt","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"toAt","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Search rules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_RulesWithPagination"}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules/{id}/run":{"get":{"summary":"Run a rule","description":"Run a rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Run a rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["rules"]}},"/api/rules/ids":{"get":{"summary":"Get rule IDs","description":"Get Rule IDs","responses":{"200":{"description":"Get Rule IDs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_RuleIDs"}}}}}},"tags":["rules"]}},"/api/tags/{name}":{"delete":{"summary":"Delete a tag","description":"Delete a tag","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete a tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mihari_Entities_Message"}}}}},"tags":["tags"]}},"/api/tags":{"get":{"summary":"Get tags","description":"Get tags","responses":{"200":{"description":"Get tags","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tags"}}}}}},"tags":["tags"]}}},"components":{"schemas":{"postApiAlerts":{"type":"object","properties":{"ruleId":{"type":"string"},"artifacts":{"type":"array","items":{"type":"string"}}},"required":["ruleId","artifacts"],"description":"Create an alert"},"Mihari_Entities_Alert":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"ruleId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_BaseArtifact"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tag"}}},"required":["id","ruleId","createdAt","tags"],"description":"Mihari_Entities_Alert model"},"Mihari_Entities_BaseArtifact":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"data":{"type":"string"},"dataType":{"type":"string"},"source":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}},"required":["id","data","dataType","source"]},"Mihari_Entities_Tag":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Mihari_Entities_Message":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"description":"Mihari_Entities_Message model"},"Mihari_Entities_AlertsWithPagination":{"type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Alert"}},"total":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"required":["alerts","total","currentPage","pageSize"],"description":"Mihari_Entities_AlertsWithPagination model"},"Mihari_Entities_Artifact":{"type":"object","properties":{"id":{"type":"string","description":"String representation of the ID"},"data":{"type":"string"},"dataType":{"type":"string"},"source":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object"},"autonomousSystem":{"$ref":"#/components/schemas/Mihari_Entities_AutonomousSystem"},"geolocation":{"$ref":"#/components/schemas/Mihari_Entities_Geolocation"},"whoisRecord":{"$ref":"#/components/schemas/Mihari_Entities_WhoisRecord"},"reverseDnsNames":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_ReverseDnsName"}},"dnsRecords":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_DnsRecord"}},"cpes":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_CPE"}},"ports":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Port"}}},"required":["id","data","dataType","source"],"description":"Mihari_Entities_Artifact model"},"Mihari_Entities_AutonomousSystem":{"type":"object","properties":{"asn":{"type":"integer","format":"int32"}},"required":["asn"]},"Mihari_Entities_Geolocation":{"type":"object","properties":{"country":{"type":"string"},"countryCode":{"type":"string"}},"required":["country","countryCode"]},"Mihari_Entities_WhoisRecord":{"type":"object","properties":{"domain":{"type":"string"},"createdOn":{"type":"string","format":"date"},"updatedOn":{"type":"string","format":"date"},"expiresOn":{"type":"string","format":"date"},"registrar":{"type":"object"},"contacts":{"type":"array","items":{"type":"object"}}},"required":["domain","contacts"]},"Mihari_Entities_ReverseDnsName":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Mihari_Entities_DnsRecord":{"type":"object","properties":{"resource":{"type":"string"},"value":{"type":"string"}},"required":["resource","value"]},"Mihari_Entities_CPE":{"type":"object","properties":{"cpe":{"type":"string"}},"required":["cpe"]},"Mihari_Entities_Port":{"type":"object","properties":{"port":{"type":"integer","format":"int32"}},"required":["port"]},"Mihari_Entities_Config":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"values":{"type":"array","items":{"type":"string"}},"isConfigured":{"type":"boolean"}},"required":["name","type","values","isConfigured"],"description":"Mihari_Entities_Config model"},"Mihari_Entities_IPAddress":{"type":"object","properties":{"ip":{"type":"string"},"countryCode":{"type":"string"},"hostname":{"type":"string"},"loc":{"type":"string"},"asn":{"type":"integer","format":"int32"}},"required":["ip","countryCode","loc"],"description":"Mihari_Entities_IPAddress model"},"putApiRules":{"type":"object","properties":{"id":{"type":"string"},"yaml":{"type":"string"}},"required":["id","yaml"],"description":"Update a rule"},"Mihari_Entities_Rule":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"yaml":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Tag"}}},"required":["id","title","description","yaml","createdAt","updatedAt","tags"],"description":"Mihari_Entities_Rule model"},"postApiRules":{"type":"object","properties":{"yaml":{"type":"string"}},"required":["yaml"],"description":"Create a rule"},"Mihari_Entities_RulesWithPagination":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/Mihari_Entities_Rule"}},"total":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"required":["rules","total","currentPage","pageSize"],"description":"Mihari_Entities_RulesWithPagination model"},"Mihari_Entities_RuleIDs":{"type":"object","properties":{"ruleIds":{"type":"string"}},"required":["ruleIds"],"description":"Mihari_Entities_RuleIDs model"},"Mihari_Entities_Tags":{"type":"object","properties":{"tags":{"type":"string"}},"required":["tags"],"description":"Mihari_Entities_Tags model"}}}}},"searchIndex":{"store":["tag/alerts","tag/alerts/paths/~1api~1alerts/post","tag/alerts/paths/~1api~1alerts/get","tag/alerts/paths/~1api~1alerts~1{id}/delete","tag/artifacts","tag/artifacts/paths/~1api~1artifacts~1{id}/delete","tag/artifacts/paths/~1api~1artifacts~1{id}/get","tag/artifacts/paths/~1api~1artifacts~1{id}~1enrich/get","tag/configs","tag/configs/paths/~1api~1configs/get","tag/ip_addresses","tag/ip_addresses/paths/~1api~1ip_addresses~1{ip}/get","tag/rules","tag/rules/paths/~1api~1rules~1{id}/delete","tag/rules/paths/~1api~1rules~1{id}/get","tag/rules/paths/~1api~1rules/put","tag/rules/paths/~1api~1rules/post","tag/rules/paths/~1api~1rules/get","tag/rules/paths/~1api~1rules~1{id}~1run/get","tag/rules/paths/~1api~1rules~1ids/get","tag/tags","tag/tags/paths/~1api~1tags~1{name}/delete","tag/tags/paths/~1api~1tags/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.218]],["description/0",[0,1.141,1,1.436]],["title/1",[0,0.932,2,1.503]],["description/1",[0,0.971,2,1.565,3,2.115]],["title/2",[0,0.932,4,1.503]],["description/2",[0,0.971,3,2.115,4,1.565]],["title/3",[0,0.932,5,0.932]],["description/3",[0,0.971,5,0.971,6,2.593]],["title/4",[7,1.218]],["description/4",[1,1.436,7,1.141]],["title/5",[5,0.932,7,0.932]],["description/5",[5,0.971,7,0.971,8,2.115]],["title/6",[7,1.218]],["description/6",[7,1.141,8,2.486]],["title/7",[7,0.932,9,2.031]],["description/7",[7,0.971,9,2.115,10,2.593]],["title/8",[11,1.964]],["description/8",[1,1.436,11,1.84]],["title/9",[11,1.964]],["description/9",[11,1.84,12,3.047]],["title/10",[13,2.654]],["description/10",[1,1.436,13,2.486]],["title/11",[14,2.031,15,2.031]],["description/11",[14,2.115,15,2.115,16,2.593]],["title/12",[17,0.44]],["description/12",[1,1.436,17,0.412]],["title/13",[5,0.932,17,0.336]],["description/13",[5,0.971,17,0.35,18,2.115]],["title/14",[17,0.44]],["description/14",[17,0.412,18,2.486]],["title/15",[17,0.336,19,2.031]],["description/15",[17,0.35,19,2.115,20,1.8]],["title/16",[2,1.503,17,0.336]],["description/16",[2,1.565,17,0.35,20,1.8]],["title/17",[4,1.503,17,0.336]],["description/17",[4,1.565,17,0.35,20,1.8]],["title/18",[17,0.336,21,2.031]],["description/18",[17,0.35,21,2.115,22,2.593]],["title/19",[17,0.336,23,2.031]],["description/19",[17,0.35,23,2.115,24,2.593]],["title/20",[25,1.533]],["description/20",[1,1.436,25,1.436]],["title/21",[5,0.932,25,1.173]],["description/21",[5,0.971,25,1.222,26,2.593]],["title/22",[25,1.533]],["description/22",[25,1.436,27,3.047]]],"invertedIndex":[["address",{"_index":15,"title":{"11":{}},"description":{"11":{}}}],["alert",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{}},"description":{"0":{},"1":{},"2":{},"3":{}}}],["api/alert",{"_index":3,"title":{},"description":{"1":{},"2":{}}}],["api/alerts/{id",{"_index":6,"title":{},"description":{"3":{}}}],["api/artifacts/{id",{"_index":8,"title":{},"description":{"5":{},"6":{}}}],["api/artifacts/{id}/enrich",{"_index":10,"title":{},"description":{"7":{}}}],["api/config",{"_index":12,"title":{},"description":{"9":{}}}],["api/ip_addresses/{ip",{"_index":16,"title":{},"description":{"11":{}}}],["api/rul",{"_index":20,"title":{},"description":{"15":{},"16":{},"17":{}}}],["api/rules/id",{"_index":24,"title":{},"description":{"19":{}}}],["api/rules/{id",{"_index":18,"title":{},"description":{"13":{},"14":{}}}],["api/rules/{id}/run",{"_index":22,"title":{},"description":{"18":{}}}],["api/tag",{"_index":27,"title":{},"description":{"22":{}}}],["api/tags/{nam",{"_index":26,"title":{},"description":{"21":{}}}],["artifact",{"_index":7,"title":{"4":{},"5":{},"6":{},"7":{}},"description":{"4":{},"5":{},"6":{},"7":{}}}],["config",{"_index":11,"title":{"8":{},"9":{}},"description":{"8":{},"9":{}}}],["creat",{"_index":2,"title":{"1":{},"16":{}},"description":{"1":{},"16":{}}}],["delet",{"_index":5,"title":{"3":{},"5":{},"13":{},"21":{}},"description":{"3":{},"5":{},"13":{},"21":{}}}],["enrich",{"_index":9,"title":{"7":{}},"description":{"7":{}}}],["id",{"_index":23,"title":{"19":{}},"description":{"19":{}}}],["ip",{"_index":14,"title":{"11":{}},"description":{"11":{}}}],["ip_address",{"_index":13,"title":{"10":{}},"description":{"10":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"4":{},"8":{},"10":{},"12":{},"20":{}}}],["rule",{"_index":17,"title":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{}},"description":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{}}}],["run",{"_index":21,"title":{"18":{}},"description":{"18":{}}}],["search",{"_index":4,"title":{"2":{},"17":{}},"description":{"2":{},"17":{}}}],["tag",{"_index":25,"title":{"20":{},"21":{},"22":{}},"description":{"20":{},"21":{},"22":{}}}],["updat",{"_index":19,"title":{"15":{}},"description":{"15":{}}}]],"pipeline":[]}},"options":{}};
|
|
420
422
|
|
|
421
423
|
var container = document.getElementById('redoc');
|
|
422
424
|
Redoc.hydrate(__redoc_state, container);
|