insightvm_api.yaml

swagger: "3.0"
info:
  title: InsightVM API
  description: An app to interact with InsightVM/Nexpose. Go to
    https://help.rapid7.com/insightvm/en-us/api/index.html for more info.
  version: "1.0"
  x-logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAK4AAACuCAYAAACvDDbuAAAgAElEQVR4Xu18B5xURbb+Vzd29yRmBgmiKCqYFjMiYnZVMKCromJk1dV1TRgXdXXdYFh19Zl9rglzXBUxISCCAcXsmkAERCRP7nBj/X/n1O1hRAys+97/dXddfzgw3X276pyvTn3nO6eu6LfZthL60hYoMQsIDdwS85geLltAA1cDoSQtoIFbkm7Tg9bA1RgoSQto4Jak2/SgNXA1BkrSAhq4Jek2PWgNXI2BkrSABm5Juk0PWgNXY6AkLaCBW5Ju04PWwNUYKEkLaOCWpNv0oDVwNQZK0gIauCXpNj1oDVyNgZK0gAZuSbpND1oDV2OgJC2ggVuSbtOD1sDVGChJC2jglqTb9KA1cDUGStICGrgl6TY9aA1cjYGStIAGbkm6TQ9aA1djoCQtoIFbkm7Tg9bA1RgoSQto4Jak2/SgNXA1BkrSAhq4Jek2PWgNXI2BkrSABm5Juk0PWgNXY6AkLaCBW5Ju04PWwNUYKEkLaOCWpNv0oDVwNQZK0gIauCXpNj1oDVyNgZK0gAZuSbpND1oDV2OgJC2ggVuSbtOD1sDVGChJC2jglqTb9KA1cDUGStICGrgl6TY9aA1cjYGStIAGbkm6TQ9aA1djoCQtoIFbkm7Tg9bA1RgoSQto4Jak2/SgNXA1BkrSAhq4Jek2PWgNXI2BkrSABm5Juk0PWgNXY6AkLaCBW5Ju04PWwNUYKEkLaOCWpNv0oDVwNQZK0gIauCXpNj1oDVyNgZK0gAZuSbpND1oDV2OgJC2ggVuSbtOD1sDVGChJC2jglqTb9KA1cDUGStICGrgl6TY9aA1cjYGStIAGbkm6TQ9aA1djoCQtoIFbkm7Tg/5ZwBWmgSiKYEDCMk3EUQQpAcl2FYCMv2VhIQSEUL+KY8CyHYSBz7+TUkLSX+g9hgkZx3SH772kpNcN9bqUMAyBKAoAIWEIA7EU/PnivYVhwDAtHlscqXurca56SR6LwWM1ob5HjYQ+Z1kGojj87qf4ZhKGaSCOJWiukILtYVk2oihmWwlL3UtI2Tk/9X0GwiiEabIxeGymZfHnyVZkzwh0XwmwnWO2uZq+mk1iDf4sf940QXdi27KXBKIwguM4iOOYX+M7C4nQMFCb9+HKEAVXoCAlnFDAigUiI0ZgAaY0YMQCBo+dBhVBihhS0L0NGJLmJdiPZLVYCEhDwJMxqujtUsJ3bITShCEFAvo83TdSFqbPFy/+6w8A4GcBN5QxHMeGaxkoZLOozqT522ICrxQwyMhdLgUiBVJ6jx9EiMIAMo5gWgakMCEsGx35AtKO8wPjJmeQachxgj3ruja8QgcyGRemaSGWBgS7SkIYAn4QIpf34aRSCINIjaq4ilaBoYKBAhaBNeW6oAHbtg0pQwWe5GKAKp+onyJmoBEw8nkPKTeDIAhhGCZMy0Yh8tWYCKwJqExDzYNwaCfAlkLCNG34Qcx/bMtFLigwsC0Zw6afJt2BhqYcT3dRoCX7KlgGYYAgDGGYDkGD/VJcMpGMQN9N8zGjVvTPB6iPcmgysghtE+nAghsKBGYM34phxias2IAZK7BLoYAbqRABMxYQUoE4MgQCIRAKiRWmCRGl4ZvVyFkCMiyg1rHRLkPkLRuGtGFKBdyiaWkt8nr8nutnAZccn3Yd7LHbzvj7NVci9AM2BEUd9iOhc5VLgTZmRze3tGL+3Lm4995xmDR5CkzbRcEP4aQziMLvRrWut+oacQmilgX87pSTcOIJo2FZFCkVmnjuZMAIuOfe+3HDjTeh4AWgCKxe+j7rUBQEZBTilltuxuDtB8E0BBzb/tZneGco3kMIBKHPC2fFiibMmTMX99//AKZMnspzNi0HAW0qXSIuga+Qy+OOO+7A0B23h0k7BkXtZNzvvvshRo06mj8rDQO2ZeKA/fbBny+9GBYNMBk+R1gCTbJ70fcRYNva2vD1woWY8vIrePyJp7CiqQm24yKKJUKyjzB5bBuJJThpx6FYN2yDaXUglgWkQoqwFkIDkEbE0VT9IdvSGCmi0w5JQURyFKXXgzCC7boIhIGcX0Bb2IFJs5vw7jLAszKI4SEyJAp2GgXhcoQm0DJwEycnm8z/DHBNw0AU+Ljphuuw6047wrZpexUwaFtOgPFtsEmOREXAhGHEIKMtdOHCRTj+xJPx1deLODpEhLwfWHFqZyaKAFhCoLG+DpNeehGuQxGEV00CEPq72ibfef9jHHbYKAjH4aj/fRFX3ZoWVwTHEnhn5pu8exDI6Dsdm6JXchVDbQJeogkR0xyiUTF8P8DSJUvx6+OPR2tbOzqClfSJhhkFAS/+iS88j149GmAaCXAlkC/4uPzKq/DgQ4/BtlNsE9/L4+Ybr8PwvfeEELGiFhwjeLNWAYP+V6RkRNdo644NeF6AV6ZNw8WX/gnLm1tgO2kEoYQwTfQOl+EXtsBx222C7uESVEXtsOIYMVwERN1MCiS0SOMkrJsQ0k7ivMevqYhpgFZ8SLuOIWDaFqq9Jsy30mitXhfPvfkl3l3hYWlVPQoyxfeKzYQWrhrn/qcirohjZNtb8fbMGejTey0IGbHBwiBgYxBv4508UsYjoBeBGwQB04xiRIwjiYIfYdjwEVjR3Iq874NQ+X1clElAFCKKA9gGcNstN2HQtlujtqaatzEyMEcGGgNFImmgI+dhw402Rk1DY0IiEi66yrom4HG0lSF6dm/AtKmTYNFtYqIJ9BdlUd5ZEupDc6PFEEXK+sQvCbjEQ+l3nu9hu0GDkQsFHDeV8GAgCn307tEdL0+aCJPHHPF9KSISbRpx4CGYNXsuhLDUgpARnhn/BDZYfx04toq4tMhonoo6AWRbzicosBCvFrQj0WJVgG5qa8O5543Fm2+/i46sz4HCERINuRYcMqAnhq3toqGwCFbsIUQK0nQRRlnYjoEw9ni9U3Ql6mDEBpHUTmpFNueoDwMx/wSsyEYuFUGaJnJhNaYtCfDw59+gKaqBlapBe8L4vje8ruaFn0UVTMQoZDswf94sSErSeNQKDDQVgzgrOTq5yIimaXAUoik5jrUyRZICza0dkMLCppsNRE23Bt4uCQyr2869IEQm7SLwcujVoxHTp04hU8HkxVJMT4pfLIGEL247aDC8SHD04qi7mosNHxNzizB4u23wwL33ADKA4GST5mPwvGLi5ibNQV0EIAIrLU4CbhHA9DU09/aOLAZuswNMy4Vp2/x5WhD77LkrbrjuGph8/5gXLAGXxtxvowHIVNUjCGg8MdZqbMALz41HVcZWO0An3+bNWkVeYSDwfebkHCgSSmCYNG+KohQaTYw55zyMH/8C05BYOMgID33aF+LC3QaiX7AQaVEgL8GMHThxAC8OIS2TIyr9R0kacVPCLoFUMV11cQxN/pEXKQSmREqGcMMATYaDF5ZKPPF5HiusBviO4uN0j+L1Q4k5vefnAdeIscH6fTHhqSc5WeBsOI6RBB0ejEHEvMtoyDdRHMErFFBdleHtuEgryFleGGPM2edg0suvJsnE6oHruBm0tTcjkzLx8ksvYK3u3SCiGK7jcvTh4MLhUEWj4u9+fcJJeH3m+xzxyMnfvWjrJFCGoB3l9+eejdHHHg3KmWhbZhwQcA3aWUJYRK6L2wJz4hgBKyWCgVNcdARcSqKOPOZEfPivj3menKyGHv74h7E47qjDkez6PCRKH5taO7DltoPgpmp517CsCJttsjEef+RBBjxocSVRnwbEKWfCgAjPFHljUhFcR9mYIyAlex4My0ShEOKQg4/AVwsWQUYGPCtAQ34ZTtyoAXv3FEiHTbBiE07swBISWWnCd2uYlzJ9YARRgkbcuujlLomrWs4w0QrbA6qiCE6Ug0il8XXVerj+rUV4p8NEnnbl5E8ikHQqJKuNLD8fuCGOPfoojD3/PIhIOTEkh8DAkmXLcdkVlysFIUlgKLOOohD9+vXDYYeNRN8+fZij0vqkaJX3fNKAMGfuXOw/YiRvb2RwWgyrQowy7UzGwcBfDMD999zJdIEcHwUhhGEj4kxbcjKjHAZQlH708X/iT3+9KpGQVie5SFC2TfKaDEO8Nm0q1u7R2BnEybChBKZPfw1PPvlk57bMkpZhYuMBG+LAESPQu3cv2A5xQIrspDIQrAx8vXAFhu27P3yyCU0+8vHog+Ow7RabJZSbVBmCl4GnJzyPsRdeDEmKgLQgo3b85sRf4+wzz+C0iCU7pgPgHeTUM85EKpViWdK1bfTfqD/23GMP9Fu/Hy80Ei9iSQvI58Xl2GnMnj0XB+z/K6SsbmhyY9TFHdim/SuctcsANIoWpCID8AW8tIUOoxpvzlmG+e0xsqaDwCDJiwJDsuN0kRjJrWqHAlJhE7ZPp7HD2o2wDIrcAlmrDsvqu+PyF17HfGcDRF3AS5/pmqitDrxrFHEJXGQsxaskjDjEnf/4bwwZvD1sU/FRgi0BhLLY0845n8HMOiJZl3XEkLkuJSHPP/c01uu7LuKQOBnnp2qLMQxsOGBzuG6V+gzvnkQElJE4eFDi4+Uw65OP4domR1alI5PTgWwuj6pMCo5tKdSSziuBxUuXY8gOu8GyUzBobLTlszyltmkGO0lmfgG2kPjXB+8x3y0GlDBW29rpY87CpCnTeMtl+sBmIUnLRj7bjucnPIUBG62vEihySsICVzS1YdvBQyAsl/Vqoluf/es9WDJUW3wQwnQcTm7OPX8sXpo0BWGQcGejgJtvvBG777oTbKZgMcJIssz2wYcf47BRozlvoEXC+rop4BXyOPjgg/HXv1yaUDlKOE1Wf3hBRQKjjz8er737KctcgfEN+rX4+PPQTdGneiHMyEI65wFuBnPcnrhuyntYaNShYLhqTqSCsN18SCNGCLXInDiELX0eY3UkcHr/bhhU68G3BAw7g9iP0VZThacXtOOJOSY6RAqmaEPBNtBh1yAVSlT5kjXkuKvAm6B4jYBbVAmLKyDX1oJvFnyJKIh561KaO/Ez4O/XXY+b7rhbGYhcnWS9qghBwryPU397As447TSeOAGatj1yPG2p/fpvAtfNMCjofnRz0gyLY6h2HBxz1CiccdqpSLsWC+tES0JSKL5ZhHvGjcNFF47lBcWXAPwwghcE2GrLIbCdFAiEDFVaNEwbFHBJOHdtC5aI8NF7b3fydnoHgZ8+t/see6Etl0c253UWKNgAlFTJGEeNGolL/zAWSoiIOvl6thBi8y22guWkWC3cYvNN8dTjD8EkNTTRWH0CnWVhy62342gasI7rQJg+nn/2GfTp2YPIilpMwoDnh7jiyqtw/0NP8k6hFrfgqKpUG6IEI3DJxRdxJHZMZqiKV8bAxJcm4aQxv0fGSMGzlqBvh8CpGzdi694tsEOBukiiOQJmZ/rg6skfYGmqJzzDVXwcMYjlGwgRGxEiYSMOiV4AFgKYIkK3fAsu231TrOd/g4iCTGTCCWJ0uC4+dXrgsslfYoVdB9PMI7BttBvVcKIQbkTFDVoc3425awRcdioJ/ww8idqMizdefZWdzPhIJCY/lDjiqCPx3mdfKC032efDJNpyUhT7OO/s03HiCSdwJDA5VTVR8APecgdssgXcVJqzfzIuRVyuWBlKlqpybLw67RWkHIsjGn1GJR0C559/Ad57/z08N+EZOGQorjipiEum3nuvEVi8ZBn8kAyjsmCV4yR6JC0gARyw3zBcdcVfmaowZZGSQZsteBi6y67wAvp3wisTPsdljzjEr489CheNPVepE0qV5fcua2rFkKE7QRgWS0X7D98H1/7tchjFCp0Q8MIQsTTRt98G6NatgVUJSgZ79qjF1CmTVOGCq2wEGcHzOOjgkZj31RJ4fp4jt2mZrO5wRTGm3SmLlydPxNq9eyGTcphDcqyMJRYsXIQ9hu8HU7rw7FZ07zBxxNom9t7AQ0MskEaEJuHinbAWt7wxByuqesMTNhF6TmDtWC0Cio5MjSIalwUrjmBLD3v1BEZtVIt1ouUIKVfwJaqjGHlh4utMT1z7zmJ8EGQQCKIxLkKRgQkPoREqbXg1uugaAVfxNZUxEwi3HrgZHrr/XjiWoaQvzliBbL6APfbcC025gCNhsQpF4CC+ywmNDDH+nw9jwEYbMRAJtyRcE3989bU38OsTf5tE3GLJk3BNIA5ZQrr2qiuw37BhsIhCsIRE2a6Fz2fNxsGHjGSKMGXyS+je0E1VqlQwRK5QwAUXXIpJk19mIAVU/qXv7wJcmkXKtnDt1Vdi9912gWuROqIqTrQbvPvhRxh19DEIqVJExDEpdihtjNipxJNPPILNN9uEF4CiLxK5XAHzFy7GiAMP4rGQwnLlZZfh4IP2Y87KdIoWKATmzP0Kw/c7EKlUGiQVer6PvX65I268/gbe3WhBRKGyt2FY2HDAJrDcagZycYdL6t1sG9o9jj36SJw15nTWvYn7F4MCvW/gdtvCz5mI0wFSOQO7Zlpw6qA61La2w7Uk2twqvLAghyc+b0JLphd8UoxYHgxhxQ4800XBAiyiB7GJSGZgRSGqghacs1UjBtWHqPFXIBYmzChEOvQgjRSWOvV45GsPjy/0kbfTEBFVKVOAyCPrBrAiE+ZqQu4aAZerVcz3VMS94LyzcexRoxTHJNdEMUek2XO+xMGHjoRPYnSRk5C2yTquRHt7Oy6+6AKcdMJoFW2pps4JGG04AieedDJef+NtpQRwtFVFCoOEaiGxzjq98czjj8F1HAY9vUb10lwhwDHHjcbHn3yK0Pfx6CMPYputtuAKE7mzqHZMfGkqfnfaGVyp4w2BNNAuwKUScT7Xjpmvv4oejfWJ7KT2KwLVjbfciptuuQ1BRAmZpexBEVAI5HIdGHPGmThrzGmqspWQG+KiBMrTzzgPU6e+zCVumtyzE8ZjvXXX5uil4paBnBfigYcew/U33YxCwVdRMwxx9phTcPJvTlQlWvYB6aoxmlvbmVZkqrvxjqg2nq7iFNk+Qv8N1sczT/8zUS8oIVbfR4txx913R9OSHKSZhxWlsYW9CJcM7YnG5jbADFAwUnh45iy8n7XQLKoAYXOuQYlsAAfZ6h5oFgZsowDpxwhFHWpiH+sZTfjLNuuiTq5AxvAQxqQyBTCRRyhsTtJeabFw40fNyKa7AZELI3YAI492N4YVGT8fuFTypNo3b3thiBmvTmWBnh0kVWJEDvpqwdd47J9PsIDetV0hk8lw3X/33XbnpIy4IEWdYlHCo+gsLGy3/WD4lCkTMBi8qkJE5VQS4O8ddzcGbz0Qtk3NIqEqpUYSr7z6Ok767anFXAwXXzgWRx5+KNMFBVzVR7BseTOG7rwrYNi8Za8EbtLbgAi5jjYsmP8lQi+vCiXFypgEnp7wLGbNnsOfK9IgyxToVlOLnXbZBev1XYeBnE5T7wbNI2b5iSJ8vw0340qZMCS61dZg+rSpTLPUrqPAFEkb+x1wML6ctyDh57TTRbhv3O3YftttVSJJuQK53/MxfsLz+MMf/6jYZrHK8C1VVcAyIjTUVePV6VOVlJbQF4rQFGx22WsYVixshSk7IIw0Nkktxp+264leLR4Cq8CL5Buk0JFpREFQzwbFFdrQAa+qJ26d/B7mxyYD16D6ulGPbrkVGLZujBPXqYNttBFoQMRDigCRlYVv2PBFFT4O6nDZ9AXIVjfCp2qcICrjwUt2wpXhbyXXXaOI2zU5oyj38QfvIO1SZqz4LXEq4m20/ZIxKFIUeTX9JJ5I2idFSo6SSa8AFxmYowpcculf8MQ/n0aYiOl8h6S0Szxw8JDt8I/bb0PakLx4KFoHUQQ/BHbadQ905H31eyGx2y474+Yb/4uTEcU1CRSSm2222XYQLxICL8lPlBgxF2aZKcb6fdfBc888tZJ/dzbTsAahZD+iPMTyqApom/zTp6acNGXIQOB5PGdBCScELv3zZbhn3MNwbAOua6HfeuvimWeeVE07zKNVFklRabNfbI0gElxFI1CHkY9PPpjJC5irdFw6NxBKgXPOvwATJ0+B56sqWWc2WgSvBGxTYt21e+C5CeO5jM38lGkWLQITA7ffCeiIYXtNgJ3Cpg3NuHDjeqzbIVFwfJihj5ztIieScj7p9aaDvLAwV9bj6smfYVFNLxgihxRZMq7FWm3zcdEe62CLoBmmE0AEJiw/DcP04dlZFEwHPjKYazTizy/NQVtVN+QsC4FhwyH5UFJhhMb37S5DtlK/zbZdffmouMcVC9/chJW09UURqqqq8O6br7J+yg5PKlHMrwyLtzD12spqCgFK8VtVW6cr8KlsS0mSwCeffo7DjzxaCY6CtmCTixWWaSGfzzIAJ058jiOaw9ov9QWQCG/jrnH34e//dSO8IGI64jo2b/MvPDue+xdYV2SOTAmmgeH7H4Av5y7g7D4knptkaNxuKCL85oRf45wzT2cArsSCatVU87BZNOf+AKUrMRCKAjp9xit43EJISdwXc77EISOPQLq6G4JCHn4hi2OOHoULLjifIy7RExIDaVHkvQhbbj2Yt2OaH4Fs400GYMJTjyhhnsdIhRyqSxgYMnRXpgsU0TmJLArXXX7aRoxddx6Cm2+8PgGuSrTp/c2tLdhu572AbIwGJ2T1Zpu1sjijbzXW8Qzk3QB2mEPMTUIxF01oyYaGizYrhRcX+Hh2sYPPoyoYlg8bEdONgaIZF+zciB75pQjCHNLIIBVkIBHAs/PwTRueTGOu2R2XTZ6DJrcauYyNgrDgEvuLHFYqlJr07etHgFtsgFO9laqcqNrnhu2zF66/5opvaZycmyQA55XPJdFEb/R8WBRpJWW5qjDgewUGHQH9zZnvYPRxo/k7iJ+mq2o4W+aeB4My5AIOP+RX+NtfLk2ihSpbUimUupQ23Xwg12iIPlBliL7W9/OY+eYbaKyv5SjFsYh4IfHUW2/DLbfezp8lnktZOwOUIlmUx3333oNtttqSkzRSCaiXV1XfinpvsbllZXeY2l9o5wlh2S4DKAhjzPriSwzbdz+W4GJyCrVwhh7G3fkPDB48SElYvMJV3+zMdz7AkUeP5kXFlcgowN6/3BM3XX/1t6pr1P3lRxKbbLY5UplqpXAkUZb0dsndeUofj4ICrr3mSuy7zz4c7el3JB3SnD766GMcdsQoSKOaS7NVwTf4zYZ1+FW9CzfKImcUkBE+rDCFgulCGpLlqgIsNDX0xCUTP8Q3cS94ohYFO0BsFLBWvoCR62QwvJ+BbmErnDiGQ2tQUkSl4gWVikNEcPBBvg5Xz5yPpvRayNsSobDghE5SlVt9XF0z4FLEJUTEEe64/b+x69BBnc3iatspNm4n1I8LFqrvtBi2VD1dmTeby3KL4TXXXo+7x92HhoZGpDNpLFuyFG4qpSIvc8QIdTXVmPzi86irTqvycsLS6HvPOff3eP6FiZx8eV7SmM6Vqgj33HUHdho6hIHLDeaRRCQEPvrkUxx8yOEw7VTSR8YdCOzobNtyzJk9i7+HCyuJMkDjoV2nE2hdgoDCfLETi6piFjw/wJ13j8O1112vGmu4yZrsF8IxgOlTJ6Ohvm5lvYkLFQJnnfN7PPf8JF4irIPHIf506SU4YuSBKlAkyiPNdcE3S7DvAQfy4g9IQ07GRGOxLYttR6XnsJDFe2+/BdexWL7kdkxq/gfw6KOP45I/XgYIWlg+GvxFOHub9bGbE8DyWhFYEWxq+yb6Y1DyZMGOQrTaabyRN3Hrh0vQZDXAiFNcTZN2ARu3L8OlO22JemMpUlEHd5pxvy7vKyaoIEf9vAUzgykrHNz56VI0mbUIUhRYTLghcd0w6V/4rpD7k4BbrENTRCUgxoGP6a+8zG14naccuINfbaPEcZkxUPabdFVlUiluLOGmatPGMxMm4Mmnn8LLU1+Fm6nm9jqiER0dHejZowfa2luZv1IViCLHWWPOwEnHj2YJhkR0ZqOcIADvffAB651BpPpsSVwnekGyWffu9ajKpBVwueaplIFvlizBzrvtycDlpcUFErW+atImZrz+GijhYnGJnWxxc1DB8zubxgkj3CGWnHgIw4ALHC2trRg//hk8+NAjXEX0iYBzhS3plqKIZQh88O5MriAWm3I4Apom9t33QMz6Yh7rtLSVU9V64ovPY+3e9VjZ+cFZA+6+9yH8/bobkKNxdckpyHa+l1AVr4Axp52CU046kbk47Wis8CSVyuNGj8a7H3zBibQr8mhsnYs/7T0IG2eXwZV5SMoR4hAFJ48IKThBmoPRoup63Pj2Arzu1SBrWdy/SxE0NlqwH5pw/sANUXAKcCMq0lC/rmowVdmGkhdb3Xrc9Xk7XloeoMPMILSp+kYN7EQVfURcIfxuevbTgZtEbNsyEORz+NeH78N1SMdU/CCK1dYz9sKL8Mor01VBIA5w+223YqstB7J2WGwwJ732xZcm4exzz+ftzUlVIe8FijeS8ySBWFV+yLz91l8P4596kgEr+ASCyqgpmaFh+UHAOif1BpDWa1LWSwCNqB5fPBdAC0n1z1GUIRViu+2HsMPVER2ltxJYh2y3Be668w6EgQfXdZmrUvJIxZHh+x2A1tZ2ldUXq4AUTZLolvcK6MhmkclUcRWQwUhJFCkLLAeGSLs2tt9mS4y76w6mParLzFRHXWBg0OChyBcCtitFd5rCzLdmwDTJHknFjFs1TRw26hh89PFnoEMdSn1MOuOoc4uS4TDEJptsjEcfvI8pCi3mdCrFeUW+4GFFcxv2/OVekHYdIAustQ5KBxiz4+bo1vQ1UiJQLYwyRjaVhZQOUl4GecPEF7U9cfm0eZgn6hEZAdK0m8GBg6W4YEAN9s1ILE0ZqPEL3HtBl0lEjY5YUbeecLDY7YW/zvgKn4sqrrp58BEZDpyI6EyBdV9FTteI4yZv7qRgkqWvzTbuj8ceeQimQZFE0UIaGCVGe+0zHEuWLINl2rBsgY026IdHHn6Av5q3LmpOlhJtHR3Ye9i+6MgW4HEzMzWkqC/iKCcD7ougNXzt1X/D3nvuwc5ljhhyDjIAABHYSURBVM2RWFXDik08VIRQTewqEnFJk/qDuflZ+ZOBm/Qm0C5y8imnY+q01/jIEC2Y4rZ8wXln4Lhjj+FxsPOpP0ECn8+eg4NHHsFzVYtHfX/Xi0qUK7tOVDFg5Qau+iyIKow99ywcf9wxDNxOTc20sXDREuy2+14wDLWrEC1bv28fvPjiBMSxB5sKLVyMpDN2AttstwP3MZMMSYuWXqG8gsZFfQp0cuOmm29CXVWGaU9MzVBkPzohEQF/vuxyPPzIY4iNDGwri/qOhThxyw2xczcb1X4LTOnDiensmUTOiRjEVpzCCrcW45eFuO+zdsiaHghzbbC5LC/RRy7B5UM3xPq5JWh2TdT71NdL/iVNNoCMCgjdDDrsOnxYqMFVby3A0lQN919ECLmcbIcWDJFHzBF3TYG7Kso5/Ylx+ikn49RTToZhqMZxBVwTy1a0YPCQneC4afU76bOe+ebrr3IFi7diLp2qbibqZ7jjzrtB0js1MxMYi+lFLIgSmOjXdx088+QTLG8RWAj0qkFbgYcP/dE2nzT5JA0TiZ5J71VN1TRQVSLlgimrGOPuexhX/O1q5sYUoana1tbWghnTJ6NP714qEvKWqsA74fkXcNa5Y2G7lDSt/gQFV8qKgO6iqRY7H+mEFs3l0Qfvx+ab9GdpjGdNQItiLjxcddW1TC1UNTLCEYcdigvGngfTlAxcVRkDmppasMsee3HhRR0YUUuEgNvYWI/TTj0Fhx5yCM+fNHjSf4u0Ju953HBE6gqXnwMLlt2MvoVvcNFug9En3wITOUAEcGhRSwFfZLgZyBchFtdvgL9O+RyzZT18ESETWshDIuXmMCzj48RNe6EqWMGNSmbsc0M6l4FlANMxsBQWlmd64rH3F2LiCgPtbgZpooUiQt6oghURcLMJcNeUKqwCXKrWxJwN346ddtyBybMqA5PxTcx870McPupojhZkeEm9QpaBQw8agbG/Pw/Mc4uJVQx88eVcHHTwoVw6Jc26mMCR8UNamXGIZ59+En3X7onamgxn/ooaUNmXNFLqckq4a7JLKgeq5gNqBifwEah5tZtUcFALh97y5sz3MeqYY/j3dC+u3sUR3p4xjXuFVaO2UgYoqbrwoj/gifHPsv7beUK2c6kpY3HPBZ+rY83vO0eYAipZBwXM/vRjPvFQ7PHgncOwcObZ52HSpJdVH0EkefHecfut2HGIarhh5pM02BOXHnf/A7CcNPNvxzC5F6Ffv/Wx8cb9+UQyzYd2OurNNQ2L7UF2pIV40K8OwRfz5vPcan0Drr0Cw/vV4NDutehRaENoB9zxZcdUZiDf94Itc+hI5fBa0IAbZyxHW7oe+bgZ9bIerZYNBwtwzVb9MTAqQDpZ9My2o9UVCJGBkC6sOETsCHxtpvBxXIW7XvkXllWtgw7TQlXkcwdg3qiBEdswBB0s4ExiDalCsokVi4eEuVx7C96ZOQM9ujcwv6X6OiUukTRw2+134rrrb+LoSUUB7helVeiYePutGZ2FAG47kZKz4ONPOAmvzXiLe2gpa2cOxxiOWSq6/dabuIlZJUrq9DA5bOq06SgUPFRVZdhp3G6ZUA3ueuIIrYDUu2cPDNp2kDrOzW8jCc3A8qZ2DNphKKgpnWgFJVc91mrE9CkT1Vk2/k7ByWYkLYwYQY6elxyj79J8+i2usPKAphpvsosUK28iRp9ePTDlpRdUYw0vMPWeCCb2Gb4/Fi5czAUOVcAJ8dabr6K2NgMRq+KDohYqp6A/JNVx4hkRdUtaR5kOEPFNjhERf4/Usao4k8IJp56GGZNfh8tN4RYag8XoY6zAGTtvjv5eFo7nw7cFS1YGKQqBgOVXw0hJLK6yMe6TNry82IafIqmyA2HswK1ysH77fFy500DUxS2IzAg922O0ulXwZQG2G7EMmBcZLK/ZADdP/RSzghTa7BQfjzepiYqUC6FOJAP0uIHiHrwmHDeJK6oJjqvaWKuhGya++BwfA+c0h22uKjhHjDoaH338iYqe3DRLOTB1JuVx5+23YeehO/C/WY7hBClmjnnKaWeqrJuPw6gWSGqwfvftmaiuoi1GOZhPtQgTV1xxJe5+4CFWDjxPJVDFUrQKvKQ7qzlTebMmk2E9t5i7CDNUHaShgREHjcTceQsQxsT9gH2H780NPIptq4PXpD0vW96GX+61H2iL/dH2/C42LvJwBWDJZesR+w3HNX+7gu1Ax/M5aZPUdeZjyNBdEIWSo63i6z4++eR9hGEBrul0WaAraZI63kQ7T5KaUZGFm/eTHg9ehQZkIYQlLBxz+qmY8sYMVMU2KwG0iBvDL3D4Vuth9wYD3bKtlJHwKQcCrik9pAIgJWy0WSZmpRrx9ymzsDi1NtqiHGyk4KUNVMfNOLqxCiP7VEMayzgJri+4yPMpmAKE4SNKVaE13Rv/mPYZ3ml1WFXwSUIj6yQN/8WOvS7ZwppGXLUhFoFL0YvAd9utNyaNHupVUr9IFRi0/WAm/FSZoiyKpVTKM20TvXushSmTn1fRJek9oEIEgYJKtU3NbZ1FgEI+jzNOORljzjyNBX8KVvSwDJrZ0qXLsS+dIKDj0TGpD6pTreupYtZKOdoT81aHHN+Z+RaqMg4fZTGoOZlPRAC/v/ASTJw4Wa10v8DlZKow8ZafKLx0ZP7zWXOx3/4HIVVVrdonf+LFoEpK2/QX0obHjj0PRx42srOcHNJRJs/HR5/OwpHHjGZ5gNYpKTgD+m+AJ//5CFfzVFWv2OanEsMify8+R6GzysfJmzolkS9QtHO5MnnKb09HU1Mr8kEA6rFPUyApeBjeHRix9QbomVuEmrCAKDYYuEQHKUEziS4IA8vNOryezeDefy3EYrsOkelCyBR8M4va/FxctetgDMy1QFgdCMwAjhfBsKmp2EUOtVhW0xu3vPIm5hoZrAgdhEYaseF0ApcDTxcAkx2+q+L+WMm3MyemiEvCecxtcaOPOxqOq/pgCYjEl0hJ+OXe+/DqJeCqBIKkG7Vl02ngaVOnYIN+fRV4ueElYlnqjjvvwXU33MRCOT23IGU7ePvN6czPuORLakTSz/C7352O6a+9AT9SXWEsrodKSiteRWmLtQ56Sotf4OaSnj26KwGfeBYFdZh4+NEncPEll3L/RD7XgenTp6HXWg2wHauzQYiOdd/3wMO46uprIelpOCvR8aPw/VbE5Uy/A7M++5QTNOolVnyYmtxD/Pdd43DDzbeq8jPtLpD4AzUKjRrJ9IZPAKv2vOTk8krgMkVIoroKJ4oXEuWYN28exowZg1kLvqbzHagTaYReAe1xC6rtEBu4Di7baiOkvBWojVrgCmovpVO66qEqRLs8y4BvxmhOr4vbps7GR6GBFpcAVwXTp6f1LMOAqmZcOHhr9FnRjkCEyDkeLBHCiGwEbg+83xTjtmnvoWWtdZA1HMCP4ZgOvCR3KVaoOSwk4P2+Izw/0mSj+m/JHpZhIdvRjuefm4D+/TfkZyjEyYE/eiINtRJSH2xNbR0nT+qoTfLwiETqHjnyYH6QRVe6zZQhBAYNHsKALuRzePjBB7HtVr9QRktWIDnmrZnv4Nhjj+fTAWTY77/UrAmkBNwgKOCaq67EsGF7c8LCT02hVkkJzPtqAXbeeVc0NjYyv5458y3YlFt2Wel0cuL0M87ClFemMQ/vKm/9KHJX4b91tRm88dp0pbDQwkpO9BJ4jz/5FMx46x0+N0d9xl4+z22PA/pvyH5wqdzWeSWeTf7NWFfqGebPm49Zs2djypQpeOqp8UwbUuk08pRcRyaqPNJlQ/hpD317VuOwHXfAZm1LYEkPNhUc6AAkz5Meq0QYMAErjawsYGGhBrc++yaaMw48K4YRZ3jrMuVSHLn7xvhlYwMyTQEiJ41WO8TSlkVYOD+HGXPnY5FThfZUN2QjKvqQJs9RRDXSdLmKEZdx8m9HXD6LRd1VFHGpobmAtpZmGEbSR0uk36Zurxg9evbiYyTq6LY6Zq3aGtWzdXLZdgYmrQTbttRZM9NmrtutvpG3BDJUNtvBVR/F2NTGTP+vqalDOlXV+Rys7wMNR8QEuBTxiSs2Ny/n7/V9HynLgk8tkoYF23FQ362BEzx6Eg8tTqrd8PaeNDDTk19osVTV1DAXJy3637skAt/jLjLagZiDJ1VASnAtx4XrkvJCD9ugb6D8oIC29na2lV2UFPjLuwK3yBHpyL/DByapZ4P+0Jz5tC9FZFJg6DwY5zwhPJFH2igglcsh7RHwST1J/jDFSWI3HcOJgdAUyIkqhJlGeC5tqCE/MyEfCrhWgJqgBen2VqRiR50ETrnw+bljGcgU9ShIpCILpie4A6yNniNmSKQj8vXKqysR+77w9KMRV8ldauthQZ50RBmqqhZlgvxveo/SWIvPHFDhfiU7SUzLeiKJ3yyEW1RZirkETHyVImRAVSqKRFSK5Y+rwiQVBwpUwrQpKVR3+37gdolL/ICSEK7rIKBHRNF4SQnh3FEJ8Twz0ikLHlJOChFtb7xbqPGz+yzVPtnJV/895PICJ+4a8yOm1KKn4gEBi1IYdfZNzS6IfK7IUTHHJ3t3mrP4l6KSkqjEFCmT5yoo6VBJc3SR1mpJA3ZESoFETGXc0Ae1ArFC6Vuq4YgrVSRuquc4qKSJABAilA4EPScupuYoolIWR8SIstoISFFkJhpG/ba8W5L8ZqNgR7CpAkjPKvMC2NQcRf6k83ACfLAyWYo/2ao/Atzi4cQkXaXEgEGqekepFY8mxo3SSU05OXamHq72LVatkjLLNjnq8TZAlTCOuCT0W+oJOPQgPeqxBXFJTv1WngXjRAtwGPCqoX11V9cHptE4LMqO6eAdHXQM6QF5VOyIuHuf5sBHkbwIFneIGQgJuEU9mJNP0pSYdyRPWfzpydmqkYTyAZUwqjKv2k1Uz65J0lbyFEUCi+VYyfmzRA9OenBX3rNrPKKFr6qH6gQR9TjTaWrVaEP8NBVJPj2btSkKCtRENkw/Ro4etic8Oj3Gj1wyaReN6eF8ITckUUMM/URYDRgFCCurjtfEdBKCOgs64EoXcZBClDKQRzNs5GH5BsywCnSgASF1g5nIuSY8+r44RrVP3wPki/2vycS6Hj4o8t1V/fwTGslXESU6fdaVfKwm7/shLePH1tWPffbHcLO6NHR1n+n6vq6vJwHsW8Nc3T1/bB5r+vqqY/xPfGfxnsWgzFXDZGDJUx7VWxJ/8ovFN3RZGFRsKn6w6yMVi2BTe1GyV6hdQ91FZSrq65NHG3QCVLVcfudI2U+ww08A7ppaX7+/pC3QGeK6AphA/QO8fnXnx7saYZXHzf4n7KOB+5+wYjnd4zt7cxJ9NXDLyctlPJdVAfw/EDV/jvV0xP051iunz642r1iV+P/fmbAG7v8dX/z/HUnnKc/iMFbKcuo3P1Tw+d8fugbu/77N/29+47cUgyJoiz+J5363mXvlRP4dmefnmUED9+fZr3w+vVrgJjKZqmn+wFxXjc6rvvU/H601cMsHehU1Ew3cinJ3+UxWA7d8fFlRM9HArSh3l89kNXDLx5cVNRMN3Ipyd/lMVgO3fHxZUTPRwK0od5fPZDVwy8eXFTUTDdyKcnf5TFYDt3x8WVEz0cCtKHeXz2Q1cMvHlxU1Ew3cinJ3+UxWA7d8fFlRM9HArSh3l89kNXDLx5cVNRMN3Ipyd/lMVgO3fHxZUTPRwK0od5fPZDVwy8eXFTUTDdyKcnf5TFYDt3x8WVEz0cCtKHeXz2Q1cMvHlxU1Ew3cinJ3+UxWA7d8fFlRM9HArSh3l89kNXDLx5cVNRMN3Ipyd/lMVgO3fHxZUTPRwK0od5fPZDVwy8eXFTUTDdyKcnf5TFYDt3x8WVEz0cCtKHeXz2Q1cMvHlxU1Ew3cinJ3+UxWA7d8fFlRM9HArSh3l89kNXDLx5cVNRMN3Ipyd/lMVgO3fHxZUTPRwK0od5fPZDVwy8eXFTUTDdyKcnf5TFYDt3x8WVEz0cCtKHeXz2Q1cMvHlxU1Ew3cinJ3+UxWA7d8fFlRM9HArSh3l89kNXDLx5cVNRMN3Ipyd/lMVgO3fHxZUTPRwK0od5fPZDVwy8eXFTUTDdyKcnf5TFYDt3x8WVEz+X/LDRENr4oWCwAAAABJRU5ErkJggg==
  contact:
    email: support@rapid7.com
    name: Rapid7
  x-categories:
    - Assets
servers:
  - url: ""
basePath: /
schemes:
  - ""
paths:
  /api/3:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Resources
      operationId: Resources
      description: Returns a listing of the resources (endpoints) that are available
        to be invoked in this API.
      parameters: []
      requestBody:
        content: {}
  /api/3/administration/commands:
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Console Commands
      operationId: Console_Commands
      description: Executes a console command against the Security Console. <span
        class="authorization">Global Administrator</span>
      parameters: []
      requestBody:
        content: {}
  /api/3/administration/info:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Information
      operationId: Information
      description: Returns system details, including host and version information.
      parameters: []
      requestBody:
        content: {}
  /api/3/administration/license:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: License
      operationId: License
      description: Returns the enabled features and limits of the current license.
        <span class="authorization">Global Administrator</span>
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: License
      operationId: License
      description: Licenses the product with an activation key or a provided license
        file. If both are provided, the license file is preferred. <span
        class="authorization">Global Administrator</span>
      parameters:
        - in: query
          name: key
          description: A license activation key.
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/administration/properties:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Properties
      operationId: Properties
      description: Returns system details, including host and version information.
      parameters: []
      requestBody:
        content: {}
  /api/3/administration/settings:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Settings
      operationId: Settings
      description: Returns the current administration settings. <span
        class="authorization">Global Administrator</span>
      parameters: []
      requestBody:
        content: {}
  /api/3/agents:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Agents
      operationId: Agents
      description: Returns the details for all agents.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/asset_groups:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Groups
      operationId: Asset_Groups
      description: Returns all asset groups.
      parameters:
        - in: query
          name: type
          description: The type of asset group.
          required: false
          schema:
            type: string
        - in: query
          name: name
          description: A search pattern for the name of the asset group. Searches are
            case-insensitive contains.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Groups
      operationId: Asset_Groups
      description: >-
        Creates a new asset group. The `searchCriteria` field can be passed no
        matter what the type of the asset group is. The asset group `type`
        changes when the assets are refreshed. Dynamic asset groups constantly
        refreshed their membership as assets are scanned whereas static asset
        groups do not change membership automatically. 

        See the <a href="#section/Responses/SearchCriteria">Search Criteria</a> for more information on using dynamic criteria.
      parameters: []
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group
      operationId: Asset_Group
      description: Deletes the asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group
      operationId: Asset_Group
      description: Returns an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group
      operationId: Asset_Group
      description: Updates the details of an asset group. See the search criteria
        endpoint (/search_criteria) for more information about building the
        search criteria and examples.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/assets":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Assets
      operationId: Asset_Group_Assets
      description: Removes the assets from the given static asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Assets
      operationId: Asset_Group_Assets
      description: Returns hypermedia links for the assets that belong to an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Assets
      operationId: Asset_Group_Assets
      description: Updates all the assets that belong to a static asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/assets/{assetId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Asset
      operationId: Asset_Group_Asset
      description: Removes an asset from an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Asset
      operationId: Asset_Group_Asset
      description: Adds an asset to a static asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/search_criteria":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Search Criteria
      operationId: Asset_Group_Search_Criteria
      description: Returns the search criteria of a dynamic asset group.For a
        reference of valid search criteria input see the <a
        href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Search Criteria
      operationId: Asset_Group_Search_Criteria
      description: Updates the search criteria of a dynamic asset group. For a
        reference of valid search criteria input see the <a
        href="#operation/getAssetsSearchUsingPOST">Asset Search</a> resource.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/tags":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Tags
      operationId: Asset_Group_Tags
      description: Removes all tag associations from the asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Tags
      operationId: Asset_Group_Tags
      description: Returns the tags assigned to an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Tags
      operationId: Asset_Group_Tags
      description: Updates the tags of an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/tags/{tagId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Resources and operations for managing asset groups
      operationId: Resources_and_operations_for_managing_asset_groups
      description: Removes a tag from an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Resources and operations for managing asset groups
      operationId: Resources_and_operations_for_managing_asset_groups
      description: Adds a tag to an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Users
      operationId: Asset_Group_Users
      description: Returns hypermedia links for the users with access to this asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Users
      operationId: Asset_Group_Users
      description: Grants users with sufficient privileges access to an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/asset_groups/{id}/users/{userId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group User
      operationId: Asset_Group_User
      description: Removes a user's access from an asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group User
      operationId: Asset_Group_User
      description: Grants a user with sufficient privileges access to the asset group.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/assets:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assets
      operationId: Assets
      description: Returns all assets for which you have access.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/assets/search:
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Search
      operationId: Asset_Search
      description: Returns all assets for which you have access that match the given
        search criteria.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{assetId}/policies":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policies For Asset
      operationId: Policies_For_Asset
      description: Retrieves the list of policies with compliance results for the
        specified asset.
      parameters:
        - in: query
          name: applicableOnly
          description: An optional boolean parameter indicating the policies retrieved
            should only include those with a policy compliance status of either
            a PASS of FAIL result. Default value is `false`, which will also
            include policies with a compliance status of NOT_APPLICABLE.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{assetId}/policies/{policyId}/children":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules or Groups Directly Under Policy For Asset
      operationId: Policy_Rules_or_Groups_Directly_Under_Policy_For_Asset
      description: Retrieves a paged resource of either policy rules, or groups, that
        are defined directly underneath the specified policy with rule
        compliance results for the specified asset.
      parameters:
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/children":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules or Groups Directly Under Policy Group For Asset
      operationId: Policy_Rules_or_Groups_Directly_Under_Policy_Group_For_Asset
      description: Retrieves a paged resource of either policy rules, or groups, that
        are defined directly underneath the specified policy group with rule
        compliance results for the specified asset.
      parameters:
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/rules":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules Under Policy Group For Asset
      operationId: Policy_Rules_Under_Policy_Group_For_Asset
      description: Retrieves the list of policy rules defined directly, or indirectly,
        underneath the specified policy group and the compliance results for the
        specified asset.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{assetId}/policies/{policyId}/rules":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules For Asset
      operationId: Policy_Rules_For_Asset
      description: Retrieves the list of policy rules with compliance results for the
        specified asset and policy.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset
      operationId: Asset
      description: Deletes the specified asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset
      operationId: Asset
      description: Returns the specified asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/databases":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Databases
      operationId: Asset_Databases
      description: Returns the databases enumerated on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/files":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Files
      operationId: Asset_Files
      description: Returns the files discovered on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/policy_overrides":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Policy Overrides
      operationId: Asset_Policy_Overrides
      description: Retrieves policy overrides defined on policy rules for the
        specified asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Services
      operationId: Asset_Services
      description: Returns the services discovered on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service
      operationId: Asset_Service
      description: Returns the service running a port and protocol on the asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/configurations":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Configurations
      operationId: Asset_Service_Configurations
      description: Returns the configuration (properties) of a port and protocol on an
        asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/databases":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Databases
      operationId: Asset_Service_Databases
      description: Returns the databases running on a port and protocol on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/user_groups":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service User Groups
      operationId: Asset_Service_User_Groups
      description: Returns the user groups enumerated on a port and protocol on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Users
      operationId: Asset_Service_Users
      description: Returns the users enumerated on a port and protocol on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Vulnerabilities
      operationId: Asset_Service_Vulnerabilities
      description: Retrieves the vulnerabilities present on a service running on an
        asset. A finding may be `invulnerable` if all instances on the service
        have exceptions applied.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/web_applications":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Web Applications
      operationId: Asset_Service_Web_Applications
      description: Returns the web applications running on a port and protocol on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/services/{protocol}/{port}/web_applications/{webApplicationId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Service Web Application
      operationId: Asset_Service_Web_Application
      description: Returns a web application running on a port and protocol on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: protocol
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: port
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: webApplicationId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/software":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Software
      operationId: Asset_Software
      description: Returns the software on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/tags":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Tags
      operationId: Asset_Tags
      description: Returns tags assigned to an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/tags/{tagId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Tag
      operationId: Asset_Tag
      description: Removes the specified tag from the asset's tags.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Tag
      operationId: Asset_Tag
      description: Assigns the specified tag to the asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/user_groups":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset User Groups
      operationId: Asset_User_Groups
      description: Returns user groups enumerated on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Users
      operationId: Asset_Users
      description: Returns users enumerated on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerabilities
      operationId: Asset_Vulnerabilities
      description: Retrieves all vulnerability findings on an asset. A finding may be
        `invulnerable` if all instances have exceptions applied.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability
      operationId: Asset_Vulnerability
      description: Retrieves the details for a vulnerability finding on an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/solution":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability Solution
      operationId: Asset_Vulnerability_Solution
      description: Returns the highest-superceding rollup solutions for a
        vulnerability on an asset. The solution(s) selected will be the most
        recent and cost-effective means by which the vulnerability can be
        remediated.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability Validations
      operationId: Asset_Vulnerability_Validations
      description: Returns all vulnerability validations for a vulnerability on an
        asset. The asset must be currently vulnerable to the validated
        vulnerable for the validation to be returned.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability Validations
      operationId: Asset_Vulnerability_Validations
      description: Creates a vulnerability validation for a vulnerability on an asset.
        The validation signifies that the vulnerability has been confirmed
        exploitable by an external tool, such as <a target="_blank"
        rel="noopener noreferrer"
        href="https://www.metasploit.com">Metasploit</a>.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/assets/{id}/vulnerabilities/{vulnerabilityId}/validations/{validationId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability Validation
      operationId: Asset_Vulnerability_Validation
      description: Removes a vulnerability validation for a vulnerability from an asset.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: validationId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Vulnerability Validation
      operationId: Asset_Vulnerability_Validation
      description: Returns a vulnerability validation for a vulnerability on an asset.
        The asset must be currently vulnerable to the validated vulnerable for
        the validation to be returned.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: vulnerabilityId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: validationId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/authentication_sources:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Authentication Sources
      operationId: Authentication_Sources
      description: Returns all available sources of authentication for users.
      parameters: []
      requestBody:
        content: {}
  "/api/3/authentication_sources/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Authentication Source
      operationId: Authentication_Source
      description: Returns the details for an authentication source.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/authentication_sources/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Authentication Source Users
      operationId: Authentication_Source_Users
      description: Returns hypermedia links for the user accounts that use the
        authentication source to authenticate.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/discovery_connections:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Discovery Connections
      operationId: Discovery_Connections
      description: Returns all discovery connections.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/discovery_connections/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Discovery Connection
      operationId: Discovery_Connection
      description: Returns a discovery connection.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/discovery_connections/{id}/connect":
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Discovery Connection Reconnect
      operationId: Discovery_Connection_Reconnect
      description: Attempts to reconnect the discovery connection.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/exploits:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exploits
      operationId: Exploits
      description: Returns all known exploits.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/exploits/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exploit
      operationId: Exploit
      description: Returns the details for an exploit.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/exploits/{id}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exploitable Vulnerabilities
      operationId: Exploitable_Vulnerabilities
      description: Returns the vulnerabilities exploitable to a exploit.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/malware_kits:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Malware Kits
      operationId: Malware_Kits
      description: Returns all known malware kits.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/malware_kits/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Malware Kit
      operationId: Malware_Kit
      description: Returns the details for a malware kit.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/malware_kits/{id}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Malware Kit Vulnerabilities
      operationId: Malware_Kit_Vulnerabilities
      description: Returns the vulnerabilities that are susceptible to being attacked
        by a malware kit.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/operating_systems:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Operating Systems
      operationId: Operating_Systems
      description: "Returns all operating systems discovered across all assets. "
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/operating_systems/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Operating System
      operationId: Operating_System
      description: Returns the details for an operating system.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/policies:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policies
      operationId: Policies
      description: Retrieves a paged resource of policies.
      parameters:
        - in: query
          name: filter
          description: Filters the retrieved policies with those whose titles that match
            the parameter.
          required: false
          schema:
            type: string
        - in: query
          name: scannedOnly
          description: Flag indicating the policies retrieved should only include those
            with Pass or Fail compliance results. The list of scanned policies
            is based on the user's list of accessible assets.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{id}/children":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules or Groups Directly Under Policy
      operationId: Policy_Rules_or_Groups_Directly_Under_Policy
      description: Retrieves a paged resource of either policy rules, or groups, that
        are defined directly underneath the specified policy.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy
      operationId: Policy
      description: Retrieves the specified policy.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Asset Results
      operationId: Policy_Asset_Results
      description: Retrieves asset resources with rule compliance results for the
        specified policy.
      parameters:
        - in: query
          name: applicableOnly
          description: An optional boolean parameter indicating the assets retrieved
            should only include those with rule results of either PASS or FAIL.
            Default value is `false`, which will also include assets with a
            compliance status of NOT_APPLICABLE.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/assets/{assetId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Asset Result
      operationId: Policy_Asset_Result
      description: Retrieves an asset resource with rule compliance results for the
        specified asset and policy.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Groups
      operationId: Policy_Groups
      description: Retrieves a paged resource of policy groups for the specified policy.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups/{groupId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Group
      operationId: Policy_Group
      description: Retrieves the specified policy group.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups/{groupId}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assets Compliance For Policy Rules Under Policy Group
      operationId: Assets_Compliance_For_Policy_Rules_Under_Policy_Group
      description: Retrieves asset resources with rule compliance status against all
        rules under the specified policy group.
      parameters:
        - in: query
          name: applicableOnly
          description: An optional boolean parameter indicating the assets retrieved
            should only include those with rule results of either PASS or FAIL.
            Default value is `false`, which will also include assets with a
            compliance status of NOT_APPLICABLE.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups/{groupId}/assets/{assetId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Compliance For Policy Rules Under Policy Group
      operationId: Asset_Compliance_For_Policy_Rules_Under_Policy_Group
      description: Retrieves an asset resource with rule compliance status against all
        rules under the specified policy group.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups/{groupId}/children":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules or Groups Directly Under Policy Group
      operationId: Policy_Rules_or_Groups_Directly_Under_Policy_Group
      description: Retrieves a paged resource of either policy rules, or groups, that
        are defined directly underneath the specified policy group.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/groups/{groupId}/rules":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules Under Policy Group
      operationId: Policy_Rules_Under_Policy_Group
      description: Retrieves the list of policy rules defined directly, or indirectly,
        underneath the specified policy group.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: groupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rules
      operationId: Policy_Rules
      description: Retrieves a paged resource of policy rules for the specified policy.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/disabled":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Disabled Policy Rules
      operationId: Disabled_Policy_Rules
      description: Retrieves a paged resource of disabled policy rules for the
        specified policy.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rule
      operationId: Policy_Rule
      description: Retrieves the specified policy rule.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assets Compliance For Policy Rule
      operationId: Assets_Compliance_For_Policy_Rule
      description: Retrieves asset resources with rule compliance results for the
        specified policy policy rule.
      parameters:
        - in: query
          name: applicableOnly
          description: An optional boolean parameter indicating the assets retrieved
            should only include those with rule results of either PASS or FAIL.
            Default value is `false`, which will also include assets with a
            compliance status of NOT_APPLICABLE.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Compliance For Policy Rule
      operationId: Asset_Compliance_For_Policy_Rule
      description: Retrieves an asset resource with rule compliance results for the
        specified policy policy rule.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}/proof":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rule Proof For Asset
      operationId: Policy_Rule_Proof_For_Asset
      description: Retrieves the policy rule proof captured during evaluation against
        the specified asset.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/controls":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rule Controls
      operationId: Policy_Rule_Controls
      description: Retrieves all NIST SP 800-53 controls mappings for each CCE within
        the specified policy rule.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/rationale":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rule Rationale
      operationId: Policy_Rule_Rationale
      description: Retrieves the policy rule rationale for the specified policy.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policies/{policyId}/rules/{ruleId}/remediation":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Rule Remediation
      operationId: Policy_Rule_Remediation
      description: Retrieves the policy rule remediation for the specified policy.
      parameters:
        - in: path
          name: policyId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: ruleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/policy/summary:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Compliance Summaries
      operationId: Policy_Compliance_Summaries
      description: Retrieves a compliance summary of all policies.
      parameters: []
      requestBody:
        content: {}
  /api/3/policy_overrides:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Overrides
      operationId: Policy_Overrides
      description: Retrieves policy overrides defined on policy rules.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Overrides
      operationId: Policy_Overrides
      description: Submit a policy override. The policy override can be submitted or
        it can be submitted and approved in a single request.
      parameters: []
      requestBody:
        content: {}
  "/api/3/policy_overrides/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Override
      operationId: Policy_Override
      description: Removes a policy override created for a policy rule.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Override
      operationId: Policy_Override
      description: Retrieve the specified policy override.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policy_overrides/{id}/expires":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Override Expiration
      operationId: Policy_Override_Expiration
      description: Get the expiration date for a policy override.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Override Expiration
      operationId: Policy_Override_Expiration
      description: Set the expiration date for a policy override. This must be a valid
        date in the future.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/policy_overrides/{id}/{status}":
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Policy Override Status
      operationId: Policy_Override_Status
      description: 'Update the status of the specified policy override. The status can
        be one of the following: `"recall"`, `"approve"`, or `"reject"`.'
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: status
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/privileges:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Privileges
      operationId: Privileges
      description: Returns all privileges that may be granted to a role.
      parameters: []
      requestBody:
        content: {}
  "/api/3/privileges/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Privilege
      operationId: Privilege
      description: Returns the details for a privilege.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/privileges/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Users With Privilege
      operationId: Users_With_Privilege
      description: Returns hypermedia links for all users granted the specified
        privilege by their role.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/report_formats:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Formats
      operationId: Report_Formats
      description: Returns all available report formats. A report format indicates an
        output file format specification (e.g. PDF, XML, etc). Some printable
        formats may be templated, and others may not. The supported templates
        for each formated are provided.
      parameters: []
      requestBody:
        content: {}
  /api/3/report_templates:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Templates
      operationId: Report_Templates
      description: Returns all available report templates.
      parameters: []
      requestBody:
        content: {}
  "/api/3/report_templates/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Template
      operationId: Report_Template
      description: "Returns the details of a report template. Report templates govern
        the contents generated within a report. "
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/reports:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Reports
      operationId: Reports
      description: Returns all defined report configurations.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Reports
      operationId: Reports
      description: Configures a new report for generation. Report types are controlled
        through either or both a format and template. Non-templatized (`export`)
        report formats do not require a template and have their output format
        preset. Templatized (`document` and `file`) report formats support a
        report template that governs the content of the output and the output
        format can be chosen from a list of supported formats.
      parameters: []
      requestBody:
        content: {}
  "/api/3/reports/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report
      operationId: Report
      description: Deletes the configuration of a report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report
      operationId: Report
      description: Returns the configuration details of a report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report
      operationId: Report
      description: Updates the configuration details of a report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/reports/{id}/generate":
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Generation
      operationId: Report_Generation
      description: Generates a configured report and returns the instance identifier
        of the report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/reports/{id}/history":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Histories
      operationId: Report_Histories
      description: Returns all historical details for generation of the report over time.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/reports/{id}/history/{instance}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report History
      operationId: Report_History
      description: Deletes an instance of a generated report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: instance
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report History
      operationId: Report_History
      description: Returns the details for a generation of the report.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: instance
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/reports/{id}/history/{instance}/output":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Report Download
      operationId: Report_Download
      description: Returns the contents of a generated report. The report content is
        usually returned in a GZip compressed format.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: instance
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/roles:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Roles
      operationId: Roles
      description: Returns all roles for which users may be assigned.
      parameters: []
      requestBody:
        content: {}
  "/api/3/roles/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Role
      operationId: Role
      description: Removes a role with the specified identifier. The role must not be
        built-in and cannot be currently assigned to any users.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Role
      operationId: Role
      description: Retrieves the details of a role.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Role
      operationId: Role
      description: Updates the details of a role.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/roles/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Users With Role
      operationId: Users_With_Role
      description: Returns hypermedia links for the the users currently assigned a role.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/scan_engine_pools:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pools
      operationId: Engine_Pools
      description: Returns engine pools available to use for scanning.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pools
      operationId: Engine_Pools
      description: Creates a new engine pool.
      parameters: []
      requestBody:
        content: {}
  "/api/3/scan_engine_pools/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool
      operationId: Engine_Pool
      description: Deletes the specified engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool
      operationId: Engine_Pool
      description: Retrieves the details for an engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool
      operationId: Engine_Pool
      description: Updates the specified engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engine_pools/{id}/engines":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool Engines
      operationId: Engine_Pool_Engines
      description: Get the engines in the engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool Engines
      operationId: Engine_Pool_Engines
      description: Set the engines in the engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engine_pools/{id}/engines/{engineId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool Engines
      operationId: Engine_Pool_Engines
      description: Remove the specified engine from the engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: engineId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool Engines
      operationId: Engine_Pool_Engines
      description: Add an engine to the engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: engineId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engine_pools/{id}/sites":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Engine Pool Sites
      operationId: Engine_Pool_Sites
      description: Returns links to the sites associated with this engine pool.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/scan_engines:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engines
      operationId: Scan_Engines
      description: Returns scan engines available to use for scanning.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engines
      operationId: Scan_Engines
      description: Creates a new scan engine.
      parameters: []
      requestBody:
        content: {}
  /api/3/scan_engines/shared_secret:
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Shared Secret
      operationId: Scan_Engine_Shared_Secret
      description: Revokes the current valid shared secret, if one exists.
      parameters: []
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Shared Secret
      operationId: Scan_Engine_Shared_Secret
      description: Returns the current valid shared secret, if one has been previously
        generated and it has not yet expired; otherwise the endpoint will
        respond with a 404 status code. Use this endpoint to detect whether a
        previously-generated shared secret is still valid.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Shared Secret
      operationId: Scan_Engine_Shared_Secret
      description: "Returns the current valid shared secret or generates a new shared
        secret. The endpoint returns an existing shared secret if one was
        previously generated and it has not yet expired. Conversely, the
        endpoint will generate and return a new shared secret for either of the
        following conditions: a shared secret was not previously generated or
        the previously-generated shared secret has expired. The shared secret is
        valid for 60 minutes from the moment it is generated."
      parameters: []
      requestBody:
        content: {}
  /api/3/scan_engines/shared_secret/time_to_live:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Shared Secret Time to live
      operationId: Scan_Engine_Shared_Secret_Time_to_live
      description: Returns the number of seconds remaining for the current shared
        secret before it expires, if one has been previously generated and it
        has not yet expired; otherwise the endpoint will respond with a 404
        status code.
      parameters: []
      requestBody:
        content: {}
  "/api/3/scan_engines/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine
      operationId: Scan_Engine
      description: Deletes the specified scan engine.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine
      operationId: Scan_Engine
      description: Retrieves the details for a scan engine.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine
      operationId: Scan_Engine
      description: Updates the specified scan engine.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engines/{id}/scan_engine_pools":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assigned Engine Pools
      operationId: Assigned_Engine_Pools
      description: Retrieves the list of engine pools the scan engine is currently
        assigned to.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engines/{id}/scans":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Scans
      operationId: Scan_Engine_Scans
      description: Returns the scans that have been run on a scan engine.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scan_engines/{id}/sites":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Engine Sites
      operationId: Scan_Engine_Sites
      description: Retrieves the list of sites the specified scan engine is assigned to.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/scan_templates:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Templates
      operationId: Scan_Templates
      description: Returns all scan templates.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Templates
      operationId: Scan_Templates
      description: Creates a new scan template.
      parameters: []
      requestBody:
        content: {}
  "/api/3/scan_templates/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Template
      operationId: Scan_Template
      description: Deletes a scan template.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Template
      operationId: Scan_Template
      description: Returns a scan template.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Template
      operationId: Scan_Template
      description: Updates a scan template.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/scans:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scans
      operationId: Scans
      description: Returns all scans.
      parameters:
        - in: query
          name: active
          description: Return running scans or past scans (true/false value).
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scans/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan
      operationId: Scan
      description: Returns the specified scan.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/scans/{id}/{status}":
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Scan Status
      operationId: Scan_Status
      description: Updates the scan status. Can pause, resume, and stop scans using
        this resource. In order to stop a scan the scan must be running or
        paused. In order to resume a scan the scan must be paused. In order to
        pause a scan the scan must be running.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: status
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/shared_credentials:
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credentials
      operationId: Shared_Credentials
      description: Deletes all shared credentials.
      parameters: []
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credentials
      operationId: Shared_Credentials
      description: Retrieves all defined shared credential resources.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credentials
      operationId: Shared_Credentials
      description: Creates a new shared credential.
      parameters: []
      requestBody:
        content: {}
  "/api/3/shared_credentials/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credential
      operationId: Shared_Credential
      description: Deletes the specified shared scan credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credential
      operationId: Shared_Credential
      description: Retrieves the specified shared credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Shared Credential
      operationId: Shared_Credential
      description: Updates the specified shared credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/sites:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sites
      operationId: Sites
      description: Retrieves a paged resource of accessible sites.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sites
      operationId: Sites
      description: Creates a new site with the specified configuration.
      parameters: []
      requestBody:
        content: {}
  "/api/3/sites/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site
      operationId: Site
      description: Deletes the site with the specified identifier.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site
      operationId: Site
      description: Retrieves the site with the specified identifier.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site
      operationId: Site
      description: Updates the configuration of the site with the specified identifier.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Alerts
      operationId: Site_Alerts
      description: Deletes all alerts from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Alerts
      operationId: Site_Alerts
      description: Retrieve all alerts defined in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/smtp":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alerts
      operationId: Site_SMTP_Alerts
      description: Deletes all SMTP alerts from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alerts
      operationId: Site_SMTP_Alerts
      description: Retrieves all SMTP alerts defined in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alerts
      operationId: Site_SMTP_Alerts
      description: Creates a new SMTP alert for the specified site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alerts
      operationId: Site_SMTP_Alerts
      description: Updates all SMTP alerts for the specified site in a single request
        using the array of resources defined in the request body.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/smtp/{alertId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alert
      operationId: Site_SMTP_Alert
      description: Deletes the specified SMTP alert from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alert
      operationId: Site_SMTP_Alert
      description: Retrieves the specified SMTP alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SMTP Alert
      operationId: Site_SMTP_Alert
      description: Updates the specified SMTP alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/snmp":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alerts
      operationId: Site_SNMP_Alerts
      description: Deletes all SNMP alerts from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alerts
      operationId: Site_SNMP_Alerts
      description: Retrieves all SNMP alerts defined in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alerts
      operationId: Site_SNMP_Alerts
      description: Creates a new SNMP alert for the specified site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alerts
      operationId: Site_SNMP_Alerts
      description: Updates all SNMP alerts for the specified site in a single request
        using the array of resources defined in the request body.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/snmp/{alertId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alert
      operationId: Site_SNMP_Alert
      description: Deletes the specified SNMP alert from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alert
      operationId: Site_SNMP_Alert
      description: Retrieves the specified SNMP alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site SNMP Alert
      operationId: Site_SNMP_Alert
      description: Updates the specified SNMP alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/syslog":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alerts
      operationId: Site_Syslog_Alerts
      description: Deletes all Syslog alerts from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alerts
      operationId: Site_Syslog_Alerts
      description: Retrieves all Syslog alerts defined in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alerts
      operationId: Site_Syslog_Alerts
      description: Creates a new Syslog alert for the specified site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alerts
      operationId: Site_Syslog_Alerts
      description: Updates all Syslog alerts for the specified site in a single
        request using the array of resources defined in the request body.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/alerts/syslog/{alertId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alert
      operationId: Site_Syslog_Alert
      description: Deletes the specified Syslog alert from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alert
      operationId: Site_Syslog_Alert
      description: Retrieves the specified Syslog alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Syslog Alert
      operationId: Site_Syslog_Alert
      description: Updates the specified Syslog alert.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: alertId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/assets":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Assets
      operationId: Site_Assets
      description: Removes all assets from the specified site. Assets will be deleted
        entirely from the Security Console if either Asset Linking is disabled
        or if Asset Linking is enabled and the asset only existed in this site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Assets
      operationId: Site_Assets
      description: Retrieves a paged resource of assets linked with the specified site.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assets
      operationId: Assets
      description: Creates or updates an asset with the specified details.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/assets/{assetId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Asset
      operationId: Site_Asset
      description: Removes an asset from a site. The asset will only be deleted if it
        belongs to no other sites.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/discovery_connection":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Discovery Connection
      operationId: Site_Discovery_Connection
      description: Retrieves the discovery connection assigned to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Discovery Connection
      operationId: Site_Discovery_Connection
      description: Updates the discovery connection assigned to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/discovery_search_criteria":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Discovery Search Criteria
      operationId: Site_Discovery_Search_Criteria
      description: Retrieve the search criteria of the dynamic site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Discovery Search Criteria
      operationId: Site_Discovery_Search_Criteria
      description: Update the search criteria of the dynamic site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/excluded_asset_groups":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Asset Groups
      operationId: Site_Excluded_Asset_Groups
      description: Removes all excluded asset groups from the specified static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Asset Groups
      operationId: Site_Excluded_Asset_Groups
      description: Retrieves the excluded asset groups in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Asset Groups
      operationId: Site_Excluded_Asset_Groups
      description: Updates the excluded asset groups in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/excluded_asset_groups/{assetGroupId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Asset Group
      operationId: Site_Excluded_Asset_Group
      description: Removes the specified asset group from the excluded asset groups
        configured in the static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/excluded_targets":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Targets
      operationId: Site_Excluded_Targets
      description: Removes one or more addresses from the site's list of excluded scan
        targets.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Targets
      operationId: Site_Excluded_Targets
      description: Retrieves the excluded targets in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Targets
      operationId: Site_Excluded_Targets
      description: Adds one or more addresses to the site's list of excluded scan targets.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Excluded Targets
      operationId: Site_Excluded_Targets
      description: Updates the excluded targets in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/included_asset_groups":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Asset Groups
      operationId: Site_Included_Asset_Groups
      description: Removes all included asset groups from the specified static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Asset Groups
      operationId: Site_Included_Asset_Groups
      description: Retrieves the included asset groups in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Asset Groups
      operationId: Site_Included_Asset_Groups
      description: Updates the included asset groups in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/included_asset_groups/{assetGroupId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Asset Group
      operationId: Site_Included_Asset_Group
      description: Removes the specified asset group from the included asset groups
        configured in the static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/included_targets":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Targets
      operationId: Site_Included_Targets
      description: Removes one or more addresses from the site's list of included scan
        targets.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Targets
      operationId: Site_Included_Targets
      description: Retrieves the included targets in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Targets
      operationId: Site_Included_Targets
      description: Adds one or more addresses to the site's list of included scan targets.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Included Targets
      operationId: Site_Included_Targets
      description: Updates the included targets in a static site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/organization":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Organization Information
      operationId: Site_Organization_Information
      description: Retrieves the site organization information.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Organization Information
      operationId: Site_Organization_Information
      description: Updates the site organization information.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/scan_engine":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Engine
      operationId: Site_Scan_Engine
      description: Retrieves the resource of the scan engine assigned to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Engine
      operationId: Site_Scan_Engine
      description: Updates the assigned scan engine to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/scan_schedules":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedules
      operationId: Site_Scan_Schedules
      description: Deletes all scan schedules from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedules
      operationId: Site_Scan_Schedules
      description: Returns all scan schedules for the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedules
      operationId: Site_Scan_Schedules
      description: Creates a new scan schedule for the specified site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedules
      operationId: Site_Scan_Schedules
      description: Updates all scan schedules for the specified site in a single
        request using the array of resources defined in the request body.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/scan_schedules/{scheduleId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedule
      operationId: Site_Scan_Schedule
      description: Deletes the specified scan schedule from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: scheduleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedule
      operationId: Site_Scan_Schedule
      description: Retrieves the specified scan schedule.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: scheduleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Schedule
      operationId: Site_Scan_Schedule
      description: Updates the specified scan schedule.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: scheduleId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/scan_template":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Template
      operationId: Site_Scan_Template
      description: Retrieves the resource of the scan template assigned to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Template
      operationId: Site_Scan_Template
      description: Updates the assigned scan template to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/scans":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scans
      operationId: Site_Scans
      description: Returns the scans for the specified site.
      parameters:
        - in: query
          name: active
          description: Return running scans or past scans (true/false value).
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scans
      operationId: Site_Scans
      description: Starts a scan for the specified site.
      parameters:
        - in: query
          name: overrideBlackout
          description: Whether to request for the override of an scan blackout window.
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/shared_credentials":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assigned Shared Credentials
      operationId: Assigned_Shared_Credentials
      description: Retrieve all of the shared credentials assigned to the site. These
        shared credentials can be enabled/disabled for the site's scan.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/shared_credentials/{credentialId}/enabled":
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Assigned Shared Credential Enablement
      operationId: Assigned_Shared_Credential_Enablement
      description: Enable or disable the shared credential for the site's scans.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: credentialId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/site_credentials":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credentials
      operationId: Site_Scan_Credentials
      description: Deletes all site credentials from the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credentials
      operationId: Site_Scan_Credentials
      description: Retrieves all defined site credential resources.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credentials
      operationId: Site_Scan_Credentials
      description: Creates a new site credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credentials
      operationId: Site_Scan_Credentials
      description: Updates multiple site credentials.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/site_credentials/{credentialId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credential
      operationId: Site_Scan_Credential
      description: Deletes the specified site credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: credentialId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credential
      operationId: Site_Scan_Credential
      description: Retrieves the specified site credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: credentialId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Scan Credential
      operationId: Site_Scan_Credential
      description: Updates the specified site credential.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: credentialId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/site_credentials/{credentialId}/enabled":
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Credential Enablement
      operationId: Site_Credential_Enablement
      description: Enable or disable the site credential for scans.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: credentialId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/tags":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Tags
      operationId: Site_Tags
      description: Retrieves the list of tags added to the sites.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Tags
      operationId: Site_Tags
      description: Updates the site's list of tags.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/tags/{tagId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Tag
      operationId: Site_Tag
      description: Removes the specified tag from the site's tags.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Tag
      operationId: Site_Tag
      description: Adds a tag to the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: tagId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/users":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Users Access
      operationId: Site_Users_Access
      description: Retrieve the list of non-administrator users that have access to
        the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Users Access
      operationId: Site_Users_Access
      description: Grants a non-administrator user access to the specified site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Users Access
      operationId: Site_Users_Access
      description: Updates the site's access list.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/users/{userId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site User Access
      operationId: Site_User_Access
      description: Removes the specified user from the site's access list.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: userId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/web_authentication/html_forms":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Web Authentication HTML Forms
      operationId: Web_Authentication_HTML_Forms
      description: Retrieves all HTML form authentications configured in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sites/{id}/web_authentication/http_headers":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Web Authentication HTTP Headers
      operationId: Web_Authentication_HTTP_Headers
      description: Retrieves all HTTP header authentications configured in the site.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/software:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Software
      operationId: Software
      description: Returns all software enumerated on any asset.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/software/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Software
      operationId: Software
      description: Returns the details for software.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/solutions:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Solutions
      operationId: Solutions
      description: Returns the details for all solutions.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/solutions/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Solution
      operationId: Solution
      description: Returns the details for a solution that can remediate one or more
        vulnerabilities.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/solutions/{id}/prerequisites":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Solution Prerequisites
      operationId: Solution_Prerequisites
      description: Returns the solutions that must be executed in order for a solution
        to resolve a vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/solutions/{id}/supersedes":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Superseded Solutions
      operationId: Superseded_Solutions
      description: Returns the solutions that are superseded by this solution.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/solutions/{id}/superseding":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Superseding Solutions
      operationId: Superseding_Solutions
      description: Returns the solutions that supersede this solution.
      parameters:
        - in: query
          name: rollup
          description: Whether to return only highest-level "rollup" superseding solutions.
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/sonar_queries:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Queries
      operationId: Sonar_Queries
      description: Returns all sonar queries.
      parameters: []
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Queries
      operationId: Sonar_Queries
      description: Creates a sonar query.
      parameters: []
      requestBody:
        content: {}
  /api/3/sonar_queries/search:
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Query Search
      operationId: Sonar_Query_Search
      description: Executes a Sonar query to discover assets with the given search criteria.
      parameters: []
      requestBody:
        content: {}
  "/api/3/sonar_queries/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Query
      operationId: Sonar_Query
      description: Removes a sonar query.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Query
      operationId: Sonar_Query
      description: Returns a sonar query.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Query
      operationId: Sonar_Query
      description: Updates a sonar query.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/sonar_queries/{id}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sonar Query Assets
      operationId: Sonar_Query_Assets
      description: Returns the assets that are discovered by a Sonar query.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/tags:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tags
      operationId: Tags
      description: Returns all tags.
      parameters:
        - in: query
          name: name
          description: name
          required: false
          schema:
            type: string
        - in: query
          name: type
          description: type
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tags
      operationId: Tags
      description: Creates a new tag.
      parameters: []
      requestBody:
        content: {}
  "/api/3/tags/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag
      operationId: Tag
      description: Deletes the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag
      operationId: Tag
      description: Returns a tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag
      operationId: Tag
      description: Updates the details of a tag. For more information about accepted
        fields for the tag search criteria see the PUT /search_criteria
        documentation.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/asset_groups":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset Groups
      operationId: Tag_Asset_Groups
      description: Removes the associations between the tag and all asset groups.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset Groups
      operationId: Tag_Asset_Groups
      description: Returns the asset groups associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset Groups
      operationId: Tag_Asset_Groups
      description: Sets the asset groups associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/asset_groups/{assetGroupId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset Group
      operationId: Tag_Asset_Group
      description: Removes an asset group from this tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset Group
      operationId: Tag_Asset_Group
      description: Adds an asset group to this tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Assets
      operationId: Tag_Assets
      description: Returns the assets tagged with a tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/assets/{assetId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset
      operationId: Tag_Asset
      description: "Removes an asset from the tag. Note: The asset must be added
        through the asset or tag, if the asset is added using a site, asset
        group, or search criteria this will not remove the asset."
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Asset
      operationId: Tag_Asset
      description: Adds an asset to the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/search_criteria":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Search Criteria
      operationId: Tag_Search_Criteria
      description: Removes the search criteria associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Search Criteria
      operationId: Tag_Search_Criteria
      description: Returns the search criteria associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Search Criteria
      operationId: Tag_Search_Criteria
      description: >
        Updates the search criteria associated with the tag. 


        The following table outlines the search criteria fields and the available operators: 

        | Field | Operators | 

        | ---------- | ---------------- | 

        | ip-address | is, is-not, in-range, not-in-range, is-like, not-like | 

        | ip-address-type | in, not-in | 

        | alternate-address-type | in | 

        | host-name | is, is-not, starts-with, ends-with, contains, does-not-contain, is-empty, is-not-empty, is-like, not-like | 

        | host-type | in, not-in | 

        | operating-system | contains, does-not-contain, is-empty, is-not-empty | 

        | software | contains, does-not-contain| 

        | open-ports | is, is-not, in-range | 

        | service-name | contains, does-not-contain | 

        | risk-score | is, is-not, in-range, is-greater-than,is-less-than | 

        | last-scan-date | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | 

        | vulnerability-assessed | is-on-or-before, is-on-or-after, is-between, is-earlier-than, is-within-the-last | 

        | vulnerability-category | is, is-not, starts-with, ends-with, contains, does-not-contain| 

        | vulnerability-cvss-score | is, is-not, in-range, is-greater-than, is-less-than | 

        | vulnerability-cvss-v3-score | is, is-not, in-range, is-greater-than, is-less-than | 

        | vulnerability-exposures | includes, does not-include | 

        | vulnerability-title | contains, does-not-contain, is, is-not, starts-with, ends-with | 

        | cve | is, is-not, contains, does-not-contain | 

        | cvss-access-complexity | is, is-not |

        | cvss-authentication-required | is, is-not |

        | cvss-access-vector | is, is-not |

        | cvss-availability-impact | is, is-not |

        | cvss-confidentiality-impact | is, is-not |

        | cvss-integrity-impact | is, is-not |

        | cvss-v3-confidentiality-impact | is, is-not |

        | cvss-v3-integrity-impact | is, is-not |

        | cvss-v3-availability-impact | is, is-not |

        | cvss-v3-attack-vector | is, is-not |

        | cvss-v3-attack-complexity | is, is-not |

        | cvss-v3-user-interaction | is, is-not |

        | cvss-v3-privileges-required | is, is-not |

        | mobile-device-last-sync | is-within-the-last, is-earlier-than | 

        | pci-compliance | is | 

        | site-id | in, not-in | 

        | criticality-tag | is, is-not, is-greater-than, is-less-than, is-applied, is-not-applied | 

        | custom-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | 

        | location-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | 

        | owner-tag | is, is-not, starts-with, ends-with, contains, does-not-contain, is-applied, is-not-applied | 

        | vulnerability-validated-status | are | 

        | vasset-cluster | is, is-not, contains, does-not-contain, starts-with | 

        | vasset-datacenter | is, is-not | 

        | vasset-host name | is, is-not, contains, does-not-contain, starts-with | 

        | vasset-power state | in, not-in | 

        | vasset-resource pool path | contains, does-not-contain | 

        | container-image | is, is-not, starts-with, ends-with, contains, does-not-contain, is-like, not-like | 

        | container-status | is, is-not | 

        | containers | are | 


        The following table outlines the operators and the values associated with them: 

        | Operator | Values | 

        | -------- | ------ | 

        | are | A single string property named "value" | 

        | is-between | A number property named "lower" and a number property named "upper" | 

        | contains | A single string property named "value" | 

        | does-not-contain | A single string property named "value" | 

        | is-earlier-than | A single number property named "value" | 

        | ends-with | A single string property named "value" | 

        | is-greater-than | A single number property named "value" | 

        | in | An array property named "values" | 

        | not-in | An array property named "values" | 

        | in-range | A number property named "lower" and a number property named "upper" | 

        | includes | An array property named "values" | 

        | is | A single string property named "value" | 

        | is-not | A single string property named "value" | 

        | is-applied | No value | 

        | is-not-applied | No value | 

        | is-empty | No value | 

        | is-not-empty | No value | 

        | is-less-than | A single number property named "value" | 

        | is-like | A single string property named "value" | 

        | does-not-contain | A single string property named "value" | 

        | not-in-range | A number property named "lower" and a number property named "upper" | 

        | not-like | A single string property named "value" | 

        | is-on-or-after | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | 

        | is-on-or-before | A single string property named "value", which is the date in ISO8601 format (yyyy-MM-dd) | 

        | starts-with | A single string property named "value" | 

        | is-within-the-last | A single number property named "value" | 


        The following fields have enumerated values: 

        | Field | Acceptable Values | 

        | ----- | ----------------- | 

        | containers | 0=present, 1=not present | 

        | vulnerability-validated-status | 0=present, 1=not present | 

        | pci-compliance | 0=fail, 1=pass | 

        | alternate-address-type | 0=IPv4, 1=IPv6 | 

        | ip-address-type | 0=IPv4, 1=IPv6 | 

        | host-type | 0=Unknown, 1=Guest, 2=Hypervisor, 3=Physical, 4=Mobile | 

        | cvss-access-complexity | L=Low, M=Medium, H=High | 

        | cvss-integrity-impact | N=None, P=Partial, C=Complete | 

        | cvss-confidentiality-impact | N=None, P=Partial, C=Complete | 

        | cvss-availability-impact | N=None, P=Partial, C=Complete | 

        | cvss-access-vector | L=Local, A=Adjacent, N=Network | 

        | cvss-authentication-required | N=None, S=Single, M=Multiple | 

        | cvss-access-complexity | L=Low, M=Medium, H=High | 

        | cvss-v3-confidentiality-impact | N=None, L=Low, H=High | 

        | cvss-v3-integrity-impact | N=None, L=Low, H=High | 

        | cvss-v3-availability-impact | N=None, L=Low, H=High | 

        | cvss-v3-attack-vector | N=Network, A=Adjacent, L=Local, P=Physical | 

        | cvss-v3-attack-complexity | L=Low, H=High | 

        | cvss-v3-user-interaction | N=None, R=Required | 

        | cvss-v3-privileges-required | N=None, L=Low, H=High | 

        | container-status | created, running, paused, restarting, exited, dead, unknown | 
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/sites":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Sites
      operationId: Tag_Sites
      description: Removes the associations between the tag and the sites.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Sites
      operationId: Tag_Sites
      description: Returns the sites associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Sites
      operationId: Tag_Sites
      description: Sets the sites associated with the tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/tags/{id}/sites/{siteId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Site
      operationId: Tag_Site
      description: Removes a site from this tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: siteId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Tag Site
      operationId: Tag_Site
      description: Adds a site to this tag.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: siteId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/users:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Users
      operationId: Users
      description: Returns all defined users. <span class="authorization">Global
        Administrator</span>
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Users
      operationId: Users
      description: Creates a new user. <span class="authorization">Global
        Administrator</span>
      parameters: []
      requestBody:
        content: {}
  "/api/3/users/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: User
      operationId: User
      description: Deletes a user account.<span class="authorization">Global
        Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: User
      operationId: User
      description: Returns the details for a user.<span class="authorization">Global
        Administrator, Current User</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: User
      operationId: User
      description: Updates the details of a user. <span class="authorization">Global
        Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/2FA":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: TwoFactor Authentication
      operationId: TwoFactor_Authentication
      description: Retrieves the current authentication token seed (key) for the user,
        if configured.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: TwoFactor Authentication
      operationId: TwoFactor_Authentication
      description: Regenerates a new authentication token seed (key) and updates it
        for the user. This key may be then be used in the appropriate 2FA
        authenticator.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: TwoFactor Authentication
      operationId: TwoFactor_Authentication
      description: Sets the authentication token seed (key) for the user. This key may
        be then be used in the appropriate 2FA authenticator.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/asset_groups":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Groups Access
      operationId: Asset_Groups_Access
      description: Revokes access to all asset groups from the user.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Groups Access
      operationId: Asset_Groups_Access
      description: Returns the asset groups to which the user has access.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Groups Access
      operationId: Asset_Groups_Access
      description: Updates the asset groups to which the user has access. Individual
        asset group access cannot be granted to users with the `allAssetGroups`
        permission. <span class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/asset_groups/{assetGroupId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Access
      operationId: Asset_Group_Access
      description: Grants the user access to the asset group. Individual asset group
        access cannot be granted to users with the `allAssetGroups` permission.
        <span class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Asset Group Access
      operationId: Asset_Group_Access
      description: Grants the user access to the asset group. Individual asset group
        access cannot be granted to users with the `allAssetGroups` permission.
        <span class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: assetGroupId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/lock":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Unlock Account
      operationId: Unlock_Account
      description: Unlocks a locked user account that has too many failed
        authentication attempts. Disabled accounts may not be unlocked.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/password":
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Password Reset
      operationId: Password_Reset
      description: Changes the password for the user. Users may only change their own
        password.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/privileges":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: User Privileges
      operationId: User_Privileges
      description: Returns the privileges granted to the user by their role. <span
        class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/sites":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sites Access
      operationId: Sites_Access
      description: Revokes access to all sites from the user.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sites Access
      operationId: Sites_Access
      description: Returns the sites to which the user has access.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Sites Access
      operationId: Sites_Access
      description: Updates the sites to which the user has access. Individual site
        access cannot be granted to users with the `allSites` permission. <span
        class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/users/{id}/sites/{siteId}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Access
      operationId: Site_Access
      description: Grants the user access to the site. Individual site access cannot
        be granted to users with the `allSites` permission. <span
        class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: siteId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Site Access
      operationId: Site_Access
      description: Grants the user access to the site. Individual site access cannot
        be granted to users with the `allSites` permission. <span
        class="authorization">Global Administrator</span>
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: siteId
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/vulnerabilities:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerabilities
      operationId: Vulnerabilities
      description: Returns all vulnerabilities that can be assessed during a scan.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability
      operationId: Vulnerability
      description: Returns the details for a vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/assets":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability Affected Assets
      operationId: Vulnerability_Affected_Assets
      description: Get the assets affected by the vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/checks":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability Checks
      operationId: Vulnerability_Checks
      description: Returns the vulnerability checks that assess for a specific
        vulnerability during a scan.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/exploits":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability Exploits
      operationId: Vulnerability_Exploits
      description: Returns the exploits that can be used to exploit a vulnerability.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/malware_kits":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability Malware Kits
      operationId: Vulnerability_Malware_Kits
      description: Returns the malware kits that are known to be used to exploit the
        vulnerability.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/references":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability References
      operationId: Vulnerability_References
      description: Returns the external references that may be associated to a
        vulnerability.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerabilities/{id}/solutions":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Vulnerability Solutions
      operationId: Vulnerability_Solutions
      description: Returns all solutions (across all platforms) that may be used to
        remediate this vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/vulnerability_categories:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Categories
      operationId: Categories
      description: Returns all vulnerabilities categories that can be assigned to a
        vulnerability. These categories group and label vulnerabilities by
        general purpose, affected systems, vendor, etc.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_categories/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Category
      operationId: Category
      description: Returns the details for a vulnerability category.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_categories/{id}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Category Vulnerabilities
      operationId: Category_Vulnerabilities
      description: Returns hypermedia links to the vulnerabilities that are in a
        vulnerability category.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/vulnerability_checks:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Checks
      operationId: Checks
      description: Returns vulnerability checks. Optional search and filtering
        parameters may be supplied to refine the results. Searching allows full
        text search of the vulnerability details a check is related to.
      parameters:
        - in: query
          name: search
          description: Vulnerability search term to find vulnerability checks for. e.g.
            `"ssh"`.
          required: false
          schema:
            type: string
        - in: query
          name: safe
          description: Whether to return vulnerability checks that are considered "safe"
            to run. Defaults to return safe and unsafe checks.
          required: false
          schema:
            type: string
        - in: query
          name: potential
          description: Whether to only return checks that result in potentially vulnerable
            results. Defaults to return all checks.
          required: false
          schema:
            type: string
        - in: query
          name: requiresCredentials
          description: Whether to only return checks that require credentials in order to
            successfully execute. Defaults to return all checks.
          required: false
          schema:
            type: string
        - in: query
          name: unique
          description: Whether to only return checks that guarantee to be executed
            once-and-only once on a host resulting in a unique result. False
            returns checks that can result in multiple occurrences of the same
            vulnerability on a host.
          required: false
          schema:
            type: string
        - in: query
          name: type
          description: The type of vulnerability checks to return. See <a
            href="#operation/vulnerabilityCheckTypesUsingGET">Check Types</a>
            for all available types.
          required: false
          schema:
            type: string
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_checks/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Check
      operationId: Check
      description: Returns the vulnerability check.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/vulnerability_checks_types:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Check Types
      operationId: Check_Types
      description: Returns the vulnerability check types. The type groups related
        vulnerability checks by their purpose, property, or related
        characteristic.
      parameters: []
      requestBody:
        content: {}
  /api/3/vulnerability_exceptions:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exceptions
      operationId: Exceptions
      description: Returns all exceptions defined on vulnerabilities.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exceptions
      operationId: Exceptions
      description: Creates a vulnerability exception.
      parameters: []
      requestBody:
        content: {}
  "/api/3/vulnerability_exceptions/{id}":
    delete:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exception
      operationId: Exception
      description: Removes an exception made on a vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exception
      operationId: Exception
      description: Returns an exception made on a vulnerability.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_exceptions/{id}/expires":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exception Expiration
      operationId: Exception_Expiration
      description: Get the expiration date for a vulnerability exception.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
    put:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exception Expiration
      operationId: Exception_Expiration
      description: Set the expiration date for a vulnerability exception. This must be
        a valid date in the future.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_exceptions/{id}/{status}":
    post:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Exception Status
      operationId: Exception_Status
      description: 'Update the status of the vulnerability exception. The status can
        be one of: `"recall"`, `"approve"`, or `"reject"`.'
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
        - in: path
          name: status
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  /api/3/vulnerability_references:
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: References
      operationId: References
      description: Returns the external references that may be associated to a
        vulnerability.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_references/{id}":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Reference
      operationId: Reference
      description: Returns an external vulnerability reference.
      parameters:
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
  "/api/3/vulnerability_references/{id}/vulnerabilities":
    get:
      responses:
        default:
          description: default
          content:
            text/plain:
              schema:
                type: string
                example: ""
      summary: Reference Vulnerabilities
      operationId: Reference_Vulnerabilities
      description: Returns the vulnerabilities that are referenced by an external reference.
      parameters:
        - in: query
          name: page
          description: The index of the page (zero-based) to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: size
          description: The number of records per page to retrieve.
          required: false
          schema:
            type: string
        - in: query
          name: sort
          description: "The criteria to sort the records by, in the format:
            `property[,ASC|DESC]`. The default sort order is ascending. Multiple
            sort criteria can be specified using multiple sort query
            parameters."
          required: false
          schema:
            type: string
        - in: path
          name: id
          description: Generated by shuffler.io OpenAPI
          required: true
          schema:
            type: string
      requestBody:
        content: {}
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
tags:
  - name: Root
  - name: Asset
  - name: Asset Discovery
  - name: Asset Group
  - name: Credential
  - name: Policy
  - name: Policy Override
  - name: Remediation
  - name: Report